diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 0a775aa902c1..443fa909a4c5 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2281,6 +2281,8 @@ Topics: File: subjectaccessreview-authorization-openshift-io-v1 - Name: 'SubjectRulesReview [authorization.openshift.io/v1]' File: subjectrulesreview-authorization-openshift-io-v1 + - Name: 'TokenRequest [authentication.k8s.io/v1]' + File: tokenrequest-authentication-k8s-io-v1 - Name: 'TokenReview [authentication.k8s.io/v1]' File: tokenreview-authentication-k8s-io-v1 - Name: 'LocalSubjectAccessReview [authorization.k8s.io/v1]' @@ -2302,6 +2304,8 @@ Topics: File: machineautoscaler-autoscaling-openshift-io-v1beta1 - Name: 'HorizontalPodAutoscaler [autoscaling/v1]' File: horizontalpodautoscaler-autoscaling-v1 + - Name: 'Scale [autoscaling/v1]' + File: scale-autoscaling-v1 - Name: Config APIs Dir: config_apis Topics: @@ -2327,6 +2331,8 @@ Topics: File: helmchartrepository-helm-openshift-io-v1beta1 - Name: 'Image [config.openshift.io/v1]' File: image-config-openshift-io-v1 + - Name: 'ImageContentPolicy [config.openshift.io/v1]' + File: imagecontentpolicy-config-openshift-io-v1 - Name: 'Infrastructure [config.openshift.io/v1]' File: infrastructure-config-openshift-io-v1 - Name: 'Ingress [config.openshift.io/v1]' @@ -2388,6 +2394,8 @@ Topics: File: imagestreamimage-image-openshift-io-v1 - Name: 'ImageStreamImport [image.openshift.io/v1]' File: imagestreamimport-image-openshift-io-v1 + - Name: 'ImageStreamLayers [image.openshift.io/v1]' + File: imagestreamlayers-image-openshift-io-v1 - Name: 'ImageStreamMapping [image.openshift.io/v1]' File: imagestreammapping-image-openshift-io-v1 - Name: 'ImageStream [image.openshift.io/v1]' @@ -2396,6 +2404,8 @@ Topics: File: imagestreamtag-image-openshift-io-v1 - Name: 'ImageTag [image.openshift.io/v1]' File: imagetag-image-openshift-io-v1 + - Name: 'SecretList [image.openshift.io/v1]' + File: secretlist-image-openshift-io-v1 - Name: Machine APIs Dir: machine_apis Topics: @@ -2424,22 +2434,22 @@ Topics: File: metadata-apis-index - Name: 'APIRequestCount [apiserver.openshift.io/v1]' File: apirequestcount-apiserver-openshift-io-v1 - - Name: 'Binding [core/v1]' - File: binding-core-v1 - - Name: 'ComponentStatus [core/v1]' - File: componentstatus-core-v1 - - Name: 'ConfigMap [core/v1]' - File: configmap-core-v1 + - Name: 'Binding [v1]' + File: binding-v1 + - Name: 'ComponentStatus [v1]' + File: componentstatus-v1 + - Name: 'ConfigMap [v1]' + File: configmap-v1 - Name: 'ControllerRevision [apps/v1]' File: controllerrevision-apps-v1 - Name: 'Event [events.k8s.io/v1]' File: event-events-k8s-io-v1 - - Name: 'Event [core/v1]' - File: event-core-v1 + - Name: 'Event [v1]' + File: event-v1 - Name: 'Lease [coordination.k8s.io/v1]' File: lease-coordination-k8s-io-v1 - - Name: 'Namespace [core/v1]' - File: namespace-core-v1 + - Name: 'Namespace [v1]' + File: namespace-v1 - Name: Monitoring APIs Dir: monitoring_apis Topics: @@ -2468,8 +2478,8 @@ Topics: File: network-apis-index - Name: 'ClusterNetwork [network.openshift.io/v1]' File: clusternetwork-network-openshift-io-v1 - - Name: 'Endpoints [core/v1]' - File: endpoints-core-v1 + - Name: 'Endpoints [v1]' + File: endpoints-v1 - Name: 'EndpointSlice [discovery.k8s.io/v1]' File: endpointslice-discovery-k8s-io-v1 - Name: 'EgressNetworkPolicy [network.openshift.io/v1]' @@ -2494,15 +2504,15 @@ Topics: File: podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1 - Name: 'Route [route.openshift.io/v1]' File: route-route-openshift-io-v1 - - Name: 'Service [core/v1]' - File: service-core-v1 + - Name: 'Service [v1]' + File: service-v1 - Name: Node APIs Dir: node_apis Topics: - Name: About Node APIs File: node-apis-index - - Name: 'Node [core/v1]' - File: node-core-v1 + - Name: 'Node [v1]' + File: node-v1 - Name: 'Profile [tuned.openshift.io/v1]' File: profile-tuned-openshift-io-v1 - Name: 'RuntimeClass [node.k8s.io/v1]' @@ -2603,6 +2613,8 @@ Topics: Topics: - Name: About Policy APIs File: policy-apis-index + - Name: 'Eviction [policy/v1]' + File: eviction-policy-v1 - Name: 'PodDisruptionBudget [policy/v1]' File: poddisruptionbudget-policy-v1 - Name: Project APIs @@ -2621,6 +2633,10 @@ Topics: File: provisioning-apis-index - Name: 'BareMetalHost [metal3.io/v1alpha1]' File: baremetalhost-metal3-io-v1alpha1 + - Name: 'FirmwareSchema [metal3.io/v1alpha1]' + File: firmwareschema-metal3-io-v1alpha1 + - Name: 'HostFirmwareSettings [metal3.io/v1alpha1]' + File: hostfirmwaresettings-metal3-io-v1alpha1 - Name: 'Provisioning [metal3.io/v1alpha1]' File: provisioning-metal3-io-v1alpha1 - Name: RBAC APIs @@ -2662,14 +2678,14 @@ Topics: File: clusterresourcequota-quota-openshift-io-v1 - Name: 'FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]' File: flowschema-flowcontrol-apiserver-k8s-io-v1beta1 - - Name: 'LimitRange [core/v1]' - File: limitrange-core-v1 + - Name: 'LimitRange [v1]' + File: limitrange-v1 - Name: 'PriorityClass [scheduling.k8s.io/v1]' File: priorityclass-scheduling-k8s-io-v1 - Name: 'PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta1]' File: prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1 - - Name: 'ResourceQuota [core/v1]' - File: resourcequota-core-v1 + - Name: 'ResourceQuota [v1]' + File: resourcequota-v1 - Name: Security APIs Dir: security_apis Topics: @@ -2687,12 +2703,12 @@ Topics: File: podsecuritypolicysubjectreview-security-openshift-io-v1 - Name: 'RangeAllocation [security.openshift.io/v1]' File: rangeallocation-security-openshift-io-v1 - - Name: 'Secret [core/v1]' - File: secret-core-v1 + - Name: 'Secret [v1]' + File: secret-v1 - Name: 'SecurityContextConstraints [security.openshift.io/v1]' File: securitycontextconstraints-security-openshift-io-v1 - - Name: 'ServiceAccount [core/v1]' - File: serviceaccount-core-v1 + - Name: 'ServiceAccount [v1]' + File: serviceaccount-v1 - Name: Storage APIs Dir: storage_apis Topics: @@ -2704,8 +2720,8 @@ Topics: File: csinode-storage-k8s-io-v1 - Name: 'CSIStorageCapacity [storage.k8s.io/v1beta1]' File: csistoragecapacity-storage-k8s-io-v1beta1 - - Name: 'PersistentVolumeClaim [core/v1]' - File: persistentvolumeclaim-core-v1 + - Name: 'PersistentVolumeClaim [v1]' + File: persistentvolumeclaim-v1 - Name: 'StorageClass [storage.k8s.io/v1]' File: storageclass-storage-k8s-io-v1 - Name: 'StorageState [migration.k8s.io/v1alpha1]' @@ -2727,8 +2743,8 @@ Topics: File: template-apis-index - Name: 'BrokerTemplateInstance [template.openshift.io/v1]' File: brokertemplateinstance-template-openshift-io-v1 - - Name: 'PodTemplate [core/v1]' - File: podtemplate-core-v1 + - Name: 'PodTemplate [v1]' + File: podtemplate-v1 - Name: 'Template [template.openshift.io/v1]' File: template-template-openshift-io-v1 - Name: 'TemplateInstance [template.openshift.io/v1]' @@ -2755,6 +2771,10 @@ Topics: File: buildconfig-build-openshift-io-v1 - Name: 'Build [build.openshift.io/v1]' File: build-build-openshift-io-v1 + - Name: 'BuildLog [build.openshift.io/v1]' + File: buildlog-build-openshift-io-v1 + - Name: 'BuildRequest [build.openshift.io/v1]' + File: buildrequest-build-openshift-io-v1 - Name: 'CronJob [batch/v1]' File: cronjob-batch-v1 - Name: 'DaemonSet [apps/v1]' @@ -2763,14 +2783,20 @@ Topics: File: deployment-apps-v1 - Name: 'DeploymentConfig [apps.openshift.io/v1]' File: deploymentconfig-apps-openshift-io-v1 + - Name: 'DeploymentConfigRollback [apps.openshift.io/v1]' + File: deploymentconfigrollback-apps-openshift-io-v1 + - Name: 'DeploymentLog [apps.openshift.io/v1]' + File: deploymentlog-apps-openshift-io-v1 + - Name: 'DeploymentRequest [apps.openshift.io/v1]' + File: deploymentrequest-apps-openshift-io-v1 - Name: 'Job [batch/v1]' File: job-batch-v1 - - Name: 'Pod [core/v1]' - File: pod-core-v1 - - Name: 'ReplicationController [core/v1]' - File: replicationcontroller-core-v1 - - Name: 'PersistentVolume [core/v1]' - File: persistentvolume-core-v1 + - Name: 'Pod [v1]' + File: pod-v1 + - Name: 'ReplicationController [v1]' + File: replicationcontroller-v1 + - Name: 'PersistentVolume [v1]' + File: persistentvolume-v1 - Name: 'ReplicaSet [apps/v1]' File: replicaset-apps-v1 - Name: 'StatefulSet [apps/v1]' diff --git a/api-config.yaml b/api-config.yaml index 14ba3415ad7e..2fc234d165ca 100644 --- a/api-config.yaml +++ b/api-config.yaml @@ -1,629 +1,334 @@ 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: - com.coreos.monitoring: monitoring.coreos.com - com.coreos.operators: operators.coreos.com - com.github.openshift.api.apps: apps.openshift.io - com.github.openshift.api.authorization: authorization.openshift.io - com.github.openshift.api.build: build.openshift.io - com.github.openshift.api.image: image.openshift.io - com.github.openshift.api.oauth: oauth.openshift.io - com.github.openshift.api.project: project.openshift.io - com.github.openshift.api.quota: quota.openshift.io - com.github.openshift.api.route: route.openshift.io - com.github.openshift.api.security: security.openshift.io - com.github.openshift.api.template: template.openshift.io - com.github.openshift.api.user: user.openshift.io - com.github.operator-framework.api.pkg.lib: packages.operators.coreos.com - com.github.operator-framework.api.pkg.operators: packages.operators.coreos.com - com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators: packages.operators.coreos.com - io.cncf.cni.k8s: k8s.cni.cncf.io - io.cncf.cni.whereabouts: whereabouts.cni.cncf.io - io.k8s.metrics.pkg.apis.metrics: metrics.k8s.io - io.k8s.api.admissionregistration: admissionregistration.k8s.io - io.k8s.api.apps: apps - io.k8s.api.authentication: authentication.k8s.io - io.k8s.api.authorization: authorization.k8s.io - io.k8s.api.autoscaling: autoscaling - io.k8s.api.batch: batch - io.k8s.api.certificates: certificates.k8s.io - io.k8s.api.coordination: coordination.k8s.io - io.k8s.api.core: core - io.k8s.api.discovery: discovery.k8s.io - io.k8s.api.events: events.k8s.io - io.k8s.api.extensions: extensions - io.k8s.api.flowcontrol: flowcontrol.apiserver.k8s.io - io.k8s.api.networking: networking.k8s.io - io.k8s.api.node: node.k8s.io - io.k8s.api.policy: policy - io.k8s.api.rbac: rbac.authorization.k8s.io - io.k8s.api.scheduling: scheduling.k8s.io - io.k8s.api.storage: storage.k8s.io - io.k8s.apiextensions-apiserver.pkg.apis.apiextensions: apiextensions.k8s.io - io.k8s.apimachinery.pkg.api: api - io.k8s.apimachinery.pkg.apis.meta: meta - io.k8s.apimachinery.pkg.util: util - io.k8s.apimachinery.pkg: pkg - io.k8s.kube-aggregator.pkg.apis.apiregistration: apiregistration.k8s.io - io.k8s.migration: migration.k8s.io - io.k8s.storage.snapshot: snapshot.storage.k8s.io - io.metal3: metal3.io - io.openshift.apiserver: apiserver.openshift.io - io.openshift.authorization: authorization.openshift.io - io.openshift.autoscaling: autoscaling.openshift.io - io.openshift.cloudcredential: cloudcredential.openshift.io - io.openshift.config: config.openshift.io - io.openshift.console: console.openshift.io - io.openshift.helm: helm.openshift.io - io.openshift.internal.security: security.internal.openshift.io - io.openshift.machine: machine.openshift.io - io.openshift.machineconfiguration: machineconfiguration.openshift.io - io.openshift.network: network.openshift.io - io.openshift.operator.controlplane: controlplane.operator.openshift.io - io.openshift.operator.imageregistry: imageregistry.operator.openshift.io - io.openshift.operator.ingress: ingress.operator.openshift.io - io.openshift.operator.network: network.operator.openshift.io - io.openshift.operator.samples: samples.operator.openshift.io - io.openshift.operator: operator.openshift.io - io.openshift.quota: quota.openshift.io - io.openshift.security: security.openshift.io - io.openshift.tuned: tuned.openshift.io 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: TokenRequest + group: authentication.k8s.io + version: v1 - 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 + - kind: Scale + group: autoscaling + version: v1 - 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: ImageContentPolicy + group: config.openshift.io + version: v1 - 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: ConsolePlugin group: console.openshift.io version: v1alpha1 - plural: consoleplugins - 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: ImageStreamLayers + group: image.openshift.io + version: v1 - 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 + - kind: SecretList + group: image.openshift.io + version: v1 - 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: APIRequestCount group: apiserver.openshift.io version: v1 - plural: apirequestcounts - namespaced: false - 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: v1 - plural: endpointslices - namespaced: true - kind: EgressNetworkPolicy group: network.openshift.io version: v1 - plural: egressnetworkpolicies - namespaced: true - kind: EgressRouter group: network.operator.openshift.io version: v1 - plural: egressrouters - 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 # Not in OpenAPI spec JSON # - kind: TokenReview # group: oauth.openshift.io @@ -633,179 +338,114 @@ apiMap: - 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: v2 - 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: Eviction + group: policy + version: v1 - kind: PodDisruptionBudget group: policy version: v1 - plural: poddisruptionbudgets - namespaced: true # https://bugzilla.redhat.com/show_bug.cgi?id=1875493 # - kind: PodSecurityPolicy # group: policy @@ -817,143 +457,95 @@ apiMap: - 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: FirmwareSchema + group: metal3.io + version: v1alpha1 + - kind: HostFirmwareSettings + group: metal3.io + version: v1alpha1 - 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: v1beta1 - 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: v1beta1 - 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 @@ -961,183 +553,123 @@ apiMap: # 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: CSIStorageCapacity group: storage.k8s.io version: v1beta1 - plural: csistoragecapacities - namespaced: true - 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: BuildLog + group: build.openshift.io + version: v1 + - kind: BuildRequest + group: build.openshift.io + version: v1 - kind: CronJob group: batch version: v1 - 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: DeploymentConfigRollback + group: apps.openshift.io + version: v1 + - kind: DeploymentLog + group: apps.openshift.io + version: v1 + - kind: DeploymentRequest + group: apps.openshift.io + version: v1 - 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 @@ -1145,3 +677,10 @@ apiMap: # version: v1alpha1 # plural: overlappingrangeipreservations # namespaced: true +# TBD +# - kind: NodeMetrics +# group: metrics.k8s.io +# version: v1beta1 +# - kind: PodMetrics +# group: metrics.k8s.io +# version: v1beta1 diff --git a/networking/configuring-node-port-service-range.adoc b/networking/configuring-node-port-service-range.adoc index 677ca269c9bb..ade953957362 100644 --- a/networking/configuring-node-port-service-range.adoc +++ b/networking/configuring-node-port-service-range.adoc @@ -22,4 +22,4 @@ include::modules/nw-nodeport-service-range-edit.adoc[leveloffset=+1] * xref:../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#configuring-ingress-cluster-traffic-nodeport[Configuring ingress cluster traffic using a NodePort] * xref:../rest_api/config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[Network [config.openshift.io/v1]] -* xref:../rest_api/network_apis/service-core-v1.adoc#service-core-v1[Service [core/v1]] +* xref:../rest_api/network_apis/service-v1.adoc#service-v1[Service [core/v1]] diff --git a/rest_api/authorization_apis/authorization-apis-index.adoc b/rest_api/authorization_apis/authorization-apis-index.adoc index 0adca07ab277..af7707a95da2 100644 --- a/rest_api/authorization_apis/authorization-apis-index.adoc +++ b/rest_api/authorization_apis/authorization-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="authorization-apis"] = Authorization APIs ifdef::product-title[] @@ -69,6 +71,17 @@ Description:: SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace -- +Type:: + `object` + +== TokenRequest [authentication.k8s.io/v1] + +Description:: ++ +-- +TokenRequest requests a token for a given service account. +-- + Type:: `object` diff --git a/rest_api/authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc index b28458ffd5ce..23c3e9f8219f 100644 --- a/rest_api/authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="localresourceaccessreview-authorization-openshift-io-v1"] = LocalResourceAccessReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -38,7 +40,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `content` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | Content is the actual content of the request for create and update | `isNonResourceURL` @@ -126,7 +128,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview`] schema | |=== @@ -135,7 +137,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[`LocalResourceAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc b/rest_api/authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc index 12e3da3be4e5..f8bce43c7d28 100644 --- a/rest_api/authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc +++ b/rest_api/authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="localsubjectaccessreview-authorization-k8s-io-v1"] = LocalSubjectAccessReview [authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | SubjectAccessReviewStatus |=== -..spec +=== .spec Description:: + -- @@ -93,7 +95,7 @@ Type:: | User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups |=== -..spec.extra +=== .spec.extra Description:: + -- @@ -106,7 +108,7 @@ Type:: -..spec.nonResourceAttributes +=== .spec.nonResourceAttributes Description:: + -- @@ -132,7 +134,7 @@ Type:: | Verb is the standard HTTP verb |=== -..spec.resourceAttributes +=== .spec.resourceAttributes Description:: + -- @@ -178,7 +180,7 @@ Type:: | Version is the API Version of the Resource. "*" means all. |=== -..status +=== .status Description:: + -- @@ -262,7 +264,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview`] schema | |=== @@ -271,7 +273,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[`LocalSubjectAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc index a98d05cae6d7..2e0443b01dea 100644 --- a/rest_api/authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="localsubjectaccessreview-authorization-openshift-io-v1"] = LocalSubjectAccessReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -41,7 +43,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `content` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | Content is the actual content of the request for create and update | `groups` @@ -141,7 +143,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview`] schema | |=== @@ -150,7 +152,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc#localsubjectaccessreview-authorization-openshift-io-v1[`LocalSubjectAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc index 2b99cde195b7..9fa726fb1ae3 100644 --- a/rest_api/authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="resourceaccessreview-authorization-openshift-io-v1"] = ResourceAccessReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -38,7 +40,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `content` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | Content is the actual content of the request for create and update | `isNonResourceURL` @@ -118,7 +120,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview`] schema | |=== @@ -127,7 +129,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[`ResourceAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc b/rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc index b170c92af228..23a319970616 100644 --- a/rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc +++ b/rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="selfsubjectaccessreview-authorization-k8s-io-v1"] = SelfSubjectAccessReview [authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | SubjectAccessReviewStatus |=== -..spec +=== .spec Description:: + -- @@ -73,7 +75,7 @@ Type:: | ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface |=== -..spec.nonResourceAttributes +=== .spec.nonResourceAttributes Description:: + -- @@ -99,7 +101,7 @@ Type:: | Verb is the standard HTTP verb |=== -..spec.resourceAttributes +=== .spec.resourceAttributes Description:: + -- @@ -145,7 +147,7 @@ Type:: | Version is the API Version of the Resource. "*" means all. |=== -..status +=== .status Description:: + -- @@ -221,7 +223,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview`] schema | |=== @@ -230,7 +232,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[`SelfSubjectAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc b/rest_api/authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc index 9f627b367b8d..f5cc689ebae9 100644 --- a/rest_api/authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc +++ b/rest_api/authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="selfsubjectrulesreview-authorization-k8s-io-v1"] = SelfSubjectRulesReview [authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete. |=== -..spec +=== .spec Description:: + -- @@ -69,7 +71,7 @@ Type:: | Namespace to evaluate rules for. Required. |=== -..status +=== .status Description:: + -- @@ -115,7 +117,7 @@ Required:: | ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. |=== -..status.nonResourceRules +=== .status.nonResourceRules Description:: + -- @@ -128,7 +130,7 @@ Type:: -..status.nonResourceRules[] +=== .status.nonResourceRules[] Description:: + -- @@ -156,7 +158,7 @@ Required:: | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. |=== -..status.resourceRules +=== .status.resourceRules Description:: + -- @@ -169,7 +171,7 @@ Type:: -..status.resourceRules[] +=== .status.resourceRules[] Description:: + -- @@ -246,7 +248,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview authorization.k8s.io/v1`] +| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview`] schema | |=== @@ -255,7 +257,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview authorization.k8s.io/v1`] +| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview`] schema +| 201 - Created +| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview`] schema +| 202 - Accepted +| xref:../authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc#selfsubjectrulesreview-authorization-k8s-io-v1[`SelfSubjectRulesReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc index a5bc933d4604..6b1548c11daa 100644 --- a/rest_api/authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="selfsubjectrulesreview-authorization-openshift-io-v1"] = SelfSubjectRulesReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | SubjectRulesReviewStatus is contains the result of a rules check |=== -..spec +=== .spec Description:: + -- @@ -67,7 +69,7 @@ Required:: | Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil means "use the scopes on this request". |=== -..status +=== .status Description:: + -- @@ -99,7 +101,7 @@ Required:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..status.rules +=== .status.rules Description:: + -- @@ -112,7 +114,7 @@ Type:: -..status.rules[] +=== .status.rules[] Description:: + -- @@ -137,7 +139,7 @@ Required:: | APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed | `attributeRestrictions` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error. | `nonResourceURLs` @@ -205,7 +207,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview authorization.openshift.io/v1`] +| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview`] schema | |=== @@ -214,7 +216,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview authorization.openshift.io/v1`] +| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview`] schema +| 201 - Created +| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview`] schema +| 202 - Accepted +| xref:../authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[`SelfSubjectRulesReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc b/rest_api/authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc index 2dfc99b87f5d..5658b9598fff 100644 --- a/rest_api/authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc +++ b/rest_api/authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="subjectaccessreview-authorization-k8s-io-v1"] = SubjectAccessReview [authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | SubjectAccessReviewStatus |=== -..spec +=== .spec Description:: + -- @@ -93,7 +95,7 @@ Type:: | User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups |=== -..spec.extra +=== .spec.extra Description:: + -- @@ -106,7 +108,7 @@ Type:: -..spec.nonResourceAttributes +=== .spec.nonResourceAttributes Description:: + -- @@ -132,7 +134,7 @@ Type:: | Verb is the standard HTTP verb |=== -..spec.resourceAttributes +=== .spec.resourceAttributes Description:: + -- @@ -178,7 +180,7 @@ Type:: | Version is the API Version of the Resource. "*" means all. |=== -..status +=== .status Description:: + -- @@ -254,7 +256,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema | |=== @@ -263,7 +265,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview authorization.k8s.io/v1`] +| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc index ddb89813466f..d97e61894e43 100644 --- a/rest_api/authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="subjectaccessreview-authorization-openshift-io-v1"] = SubjectAccessReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -41,7 +43,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `content` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | Content is the actual content of the request for create and update | `groups` @@ -133,7 +135,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview`] schema | |=== @@ -142,7 +144,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview authorization.openshift.io/v1`] +| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview`] schema +| 201 - Created +| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview`] schema +| 202 - Accepted +| xref:../authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc#subjectaccessreview-authorization-openshift-io-v1[`SubjectAccessReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc b/rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc index af65edf34842..3f55d7a0568b 100644 --- a/rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc +++ b/rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="subjectrulesreview-authorization-openshift-io-v1"] = SubjectRulesReview [authorization.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | SubjectRulesReviewStatus is contains the result of a rules check |=== -..spec +=== .spec Description:: + -- @@ -77,7 +79,7 @@ Required:: | User is optional. At least one of User and Groups must be specified. |=== -..status +=== .status Description:: + -- @@ -109,7 +111,7 @@ Required:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..status.rules +=== .status.rules Description:: + -- @@ -122,7 +124,7 @@ Type:: -..status.rules[] +=== .status.rules[] Description:: + -- @@ -147,7 +149,7 @@ Required:: | APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed | `attributeRestrictions` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error. | `nonResourceURLs` @@ -215,7 +217,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview authorization.openshift.io/v1`] +| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview`] schema | |=== @@ -224,7 +226,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview authorization.openshift.io/v1`] +| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview`] schema +| 201 - Created +| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview`] schema +| 202 - Accepted +| xref:../authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc#subjectrulesreview-authorization-openshift-io-v1[`SubjectRulesReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc b/rest_api/authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc new file mode 100644 index 000000000000..799f916a9bb1 --- /dev/null +++ b/rest_api/authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc @@ -0,0 +1,216 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="tokenrequest-authentication-k8s-io-v1"] += TokenRequest [authentication.k8s.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +TokenRequest requests a token for a given service account. +-- + +Type:: + `object` + +Required:: + - `spec` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| TokenRequestSpec contains client provided parameters of a token request. + +| `status` +| `object` +| TokenRequestStatus is the result of a token request. + +|=== +=== .spec +Description:: ++ +-- +TokenRequestSpec contains client provided parameters of a token request. +-- + +Type:: + `object` + +Required:: + - `audiences` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `audiences` +| `array (string)` +| Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. + +| `boundObjectRef` +| `object` +| BoundObjectReference is a reference to an object that a token is bound to. + +| `expirationSeconds` +| `integer` +| ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. + +|=== +=== .spec.boundObjectRef +Description:: ++ +-- +BoundObjectReference is a reference to an object that a token is bound to. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `kind` +| `string` +| Kind of the referent. Valid kinds are 'Pod' and 'Secret'. + +| `name` +| `string` +| Name of the referent. + +| `uid` +| `string` +| UID of the referent. + +|=== +=== .status +Description:: ++ +-- +TokenRequestStatus is the result of a token request. +-- + +Type:: + `object` + +Required:: + - `token` + - `expirationTimestamp` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `expirationTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| ExpirationTimestamp is the time of expiration of the returned token. + +| `token` +| `string` +| Token is the opaque bearer token. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/namespaces/{namespace}/serviceaccounts/{name}/token` +- `POST`: create token of a ServiceAccount + + +=== /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the TokenRequest +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create token of a ServiceAccount + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema +| 201 - Created +| xref:../authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema +| 202 - Accepted +| xref:../authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.adoc b/rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.adoc index 1fd93f182979..fd4743673a8e 100644 --- a/rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.adoc +++ b/rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="tokenreview-authentication-k8s-io-v1"] = TokenReview [authentication.k8s.io/v1] ifdef::product-title[] @@ -35,8 +37,8 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| | `spec` | `object` @@ -47,7 +49,7 @@ Required:: | TokenReviewStatus is the result of the token authentication request. |=== -..spec +=== .spec Description:: + -- @@ -73,7 +75,7 @@ Type:: | Token is the opaque bearer token. |=== -..status +=== .status Description:: + -- @@ -107,7 +109,7 @@ Type:: | UserInfo holds the information about the user needed to implement the user.Info interface. |=== -..status.user +=== .status.user Description:: + -- @@ -145,7 +147,7 @@ Type:: | The name that uniquely identifies this user among all active users. |=== -..status.user.extra +=== .status.user.extra Description:: + -- @@ -163,10 +165,62 @@ Type:: The following API endpoints are available: +* `/apis/oauth.openshift.io/v1/tokenreviews` +- `POST`: create a TokenReview * `/apis/authentication.k8s.io/v1/tokenreviews` - `POST`: create a TokenReview +=== /apis/oauth.openshift.io/v1/tokenreviews + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create a TokenReview + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview_v2`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview_v2`] schema +| 201 - Created +| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview_v2`] schema +| 202 - Accepted +| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview_v2`] schema +| 401 - Unauthorized +| Empty +|=== + + === /apis/authentication.k8s.io/v1/tokenreviews @@ -198,7 +252,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview authentication.k8s.io/v1`] +| `TokenReview` schema | |=== @@ -207,7 +261,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[`TokenReview authentication.k8s.io/v1`] +| `TokenReview` schema +| 201 - Created +| `TokenReview` schema +| 202 - Accepted +| `TokenReview` schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/autoscale_apis/autoscale-apis-index.adoc b/rest_api/autoscale_apis/autoscale-apis-index.adoc index 49bcffa07372..1dc963a4077e 100644 --- a/rest_api/autoscale_apis/autoscale-apis-index.adoc +++ b/rest_api/autoscale_apis/autoscale-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="autoscale-apis"] = Autoscale APIs ifdef::product-title[] @@ -39,3 +41,14 @@ configuration of a horizontal pod autoscaler. Type:: `object` +== Scale [autoscaling/v1] + +Description:: ++ +-- +Scale represents a scaling request for a resource. +-- + +Type:: + `object` + diff --git a/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc b/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc index be2d3f876053..2bd3f8e1a19d 100644 --- a/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc +++ b/rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterautoscaler-autoscaling-openshift-io-v1"] = ClusterAutoscaler [autoscaling.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | Most recently observed status of ClusterAutoscaler resource |=== -..spec +=== .spec Description:: + -- @@ -95,7 +97,7 @@ Type:: | Enables/Disables `--skip-nodes-with-local-storage` CA feature flag. If true cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath. true by default at autoscaler |=== -..spec.resourceLimits +=== .spec.resourceLimits Description:: + -- @@ -133,7 +135,7 @@ Type:: | Minimum and maximum number of gigabytes of memory in cluster, in the format :. Cluster autoscaler will not scale the cluster beyond these numbers. |=== -..spec.resourceLimits.cores +=== .spec.resourceLimits.cores Description:: + -- @@ -162,7 +164,7 @@ Required:: | |=== -..spec.resourceLimits.gpus +=== .spec.resourceLimits.gpus Description:: + -- @@ -175,7 +177,7 @@ Type:: -..spec.resourceLimits.gpus[] +=== .spec.resourceLimits.gpus[] Description:: + -- @@ -209,7 +211,7 @@ Required:: | |=== -..spec.resourceLimits.memory +=== .spec.resourceLimits.memory Description:: + -- @@ -238,7 +240,7 @@ Required:: | |=== -..spec.scaleDown +=== .spec.scaleDown Description:: + -- @@ -278,7 +280,7 @@ Required:: | How long a node should be unneeded before it is eligible for scale down |=== -..status +=== .status Description:: + -- @@ -377,7 +379,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -434,7 +438,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterautoscalerlist-autoscaling-openshift-io-v1[`ClusterAutoscalerList autoscaling.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.autoscaling.v1.ClusterAutoscalerList[`ClusterAutoscalerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -461,7 +467,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema | |=== @@ -470,7 +476,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 202 - Accepted +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== @@ -524,7 +536,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -533,7 +545,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -560,7 +576,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -587,7 +605,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -596,7 +614,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -623,7 +643,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema | |=== @@ -632,7 +652,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== @@ -680,7 +704,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -707,7 +733,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -716,7 +742,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -743,7 +771,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema | |=== @@ -752,7 +780,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler autoscaling.openshift.io/v1`] +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`ClusterAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc b/rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc index 303b23e39d57..613a79c4a4e5 100644 --- a/rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc +++ b/rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="horizontalpodautoscaler-autoscaling-v1"] = HorizontalPodAutoscaler [autoscaling/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | current status of a horizontal pod autoscaler |=== -..spec +=== .spec Description:: + -- @@ -82,7 +84,7 @@ Required:: | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. |=== -..spec.scaleTargetRef +=== .spec.scaleTargetRef Description:: + -- @@ -115,7 +117,7 @@ Required:: | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..status +=== .status Description:: + -- @@ -148,7 +150,7 @@ Required:: | desired number of replicas of pods managed by this autoscaler. | `lastScaleTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. | `observedGeneration` @@ -163,15 +165,21 @@ The following API endpoints are available: * `/apis/autoscaling/v1/horizontalpodautoscalers` - `GET`: list or watch objects of kind HorizontalPodAutoscaler +* `/apis/autoscaling/v1/watch/horizontalpodautoscalers` +- `GET`: watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers` - `DELETE`: delete collection of HorizontalPodAutoscaler - `GET`: list or watch objects of kind HorizontalPodAutoscaler - `POST`: create a HorizontalPodAutoscaler +* `/apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers` +- `GET`: watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}` - `DELETE`: delete a HorizontalPodAutoscaler - `GET`: read the specified HorizontalPodAutoscaler - `PATCH`: partially update the specified HorizontalPodAutoscaler - `PUT`: replace the specified HorizontalPodAutoscaler +* `/apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}` +- `GET`: watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` - `GET`: read status of the specified HorizontalPodAutoscaler - `PATCH`: partially update status of the specified HorizontalPodAutoscaler @@ -237,7 +245,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#horizontalpodautoscalerlist-autoscaling-v1[`HorizontalPodAutoscalerList autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList[`HorizontalPodAutoscalerList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/autoscaling/v1/watch/horizontalpodautoscalers + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -320,7 +395,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -329,7 +404,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -386,7 +463,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#horizontalpodautoscalerlist-autoscaling-v1[`HorizontalPodAutoscalerList autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList[`HorizontalPodAutoscalerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -413,7 +492,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema | |=== @@ -422,7 +501,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 202 - Accepted +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -479,7 +637,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -488,7 +646,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -503,7 +665,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -533,7 +697,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -542,7 +706,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -569,7 +737,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema | |=== @@ -578,7 +746,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the HorizontalPodAutoscaler +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -617,7 +865,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -647,7 +897,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -656,7 +906,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -683,7 +937,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema | |=== @@ -692,7 +946,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler autoscaling/v1`] +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`HorizontalPodAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc b/rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc index 5291abadfd78..5188f74bf292 100644 --- a/rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc +++ b/rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machineautoscaler-autoscaling-openshift-io-v1beta1"] = MachineAutoscaler [autoscaling.openshift.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | Most recently observed status of a scalable resource |=== -..spec +=== .spec Description:: + -- @@ -79,7 +81,7 @@ Required:: | ScaleTargetRef holds reference to a scalable resource |=== -..spec.scaleTargetRef +=== .spec.scaleTargetRef Description:: + -- @@ -112,7 +114,7 @@ Required:: | Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace. |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | LastTargetRef holds reference to the recently observed scalable resource |=== -..status.lastTargetRef +=== .status.lastTargetRef Description:: + -- @@ -248,7 +250,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machineautoscalerlist-autoscaling-openshift-io-v1beta1[`MachineAutoscalerList autoscaling.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.autoscaling.v1beta1.MachineAutoscalerList[`MachineAutoscalerList`] schema +| 401 - Unauthorized +| Empty |=== @@ -326,7 +330,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +389,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machineautoscalerlist-autoscaling-openshift-io-v1beta1[`MachineAutoscalerList autoscaling.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.autoscaling.v1beta1.MachineAutoscalerList[`MachineAutoscalerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +418,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema | |=== @@ -419,7 +427,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 202 - Accepted +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== @@ -476,7 +490,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -485,7 +499,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -512,7 +530,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +559,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -548,7 +568,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -575,7 +597,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema | |=== @@ -584,7 +606,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== @@ -635,7 +661,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -662,7 +690,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -671,7 +699,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -698,7 +728,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema | |=== @@ -707,7 +737,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler autoscaling.openshift.io/v1beta1`] +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 201 - Created +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`MachineAutoscaler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/autoscale_apis/scale-autoscaling-v1.adoc b/rest_api/autoscale_apis/scale-autoscaling-v1.adoc new file mode 100644 index 000000000000..f6c2cfe659b2 --- /dev/null +++ b/rest_api/autoscale_apis/scale-autoscaling-v1.adoc @@ -0,0 +1,618 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="scale-autoscaling-v1"] += Scale [autoscaling/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Scale represents a scaling request for a resource. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +| `spec` +| `object` +| ScaleSpec describes the attributes of a scale subresource. + +| `status` +| `object` +| ScaleStatus represents the current status of a scale subresource. + +|=== +=== .spec +Description:: ++ +-- +ScaleSpec describes the attributes of a scale subresource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `replicas` +| `integer` +| desired number of instances for the scaled object. + +|=== +=== .status +Description:: ++ +-- +ScaleStatus represents the current status of a scale subresource. +-- + +Type:: + `object` + +Required:: + - `replicas` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `replicas` +| `integer` +| actual number of observed instances of the scaled object. + +| `selector` +| `string` +| label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale` +- `GET`: read scale of the specified Deployment +- `PATCH`: partially update scale of the specified Deployment +- `PUT`: replace scale of the specified Deployment +* `/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale` +- `GET`: read scale of the specified ReplicaSet +- `PATCH`: partially update scale of the specified ReplicaSet +- `PUT`: replace scale of the specified ReplicaSet +* `/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale` +- `GET`: read scale of the specified StatefulSet +- `PATCH`: partially update scale of the specified StatefulSet +- `PUT`: replace scale of the specified StatefulSet +* `/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale` +- `GET`: read scale of the specified ReplicationController +- `PATCH`: partially update scale of the specified ReplicationController +- `PUT`: replace scale of the specified ReplicationController + + +=== /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Scale +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read scale of the specified Deployment + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update scale of the specified Deployment + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace scale of the specified Deployment + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Scale +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read scale of the specified ReplicaSet + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update scale of the specified ReplicaSet + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace scale of the specified ReplicaSet + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Scale +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read scale of the specified StatefulSet + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update scale of the specified StatefulSet + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace scale of the specified StatefulSet + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Scale +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read scale of the specified ReplicationController + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update scale of the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace scale of the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 201 - Created +| xref:../autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[`Scale`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/config_apis/apiserver-config-openshift-io-v1.adoc b/rest_api/config_apis/apiserver-config-openshift-io-v1.adoc index 894175705039..4f9bcbf18ca5 100644 --- a/rest_api/config_apis/apiserver-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/apiserver-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="apiserver-config-openshift-io-v1"] = APIServer [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -91,7 +93,7 @@ Type:: If unset, a default (which may change between releases) is chosen. Note that only Old, Intermediate and Custom profiles are currently supported, and the maximum available MinTLSVersions is VersionTLS12. |=== -..spec.audit +=== .spec.audit Description:: + -- @@ -120,11 +122,11 @@ Type:: | `string` | profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules. The following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody level). - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens. - Warning: to raise a Red Hat support request, it is required to set this to Default, WriteRequestBodies, or AllRequestBodies to generate audit log events that can be analyzed by support. + Warning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly. If unset, the 'Default' profile is used as the default. |=== -..spec.audit.customRules +=== .spec.audit.customRules Description:: + -- @@ -137,7 +139,7 @@ Type:: -..spec.audit.customRules[] +=== .spec.audit.customRules[] Description:: + -- @@ -168,7 +170,7 @@ Required:: If unset, the 'Default' profile is used as the default. |=== -..spec.clientCA +=== .spec.clientCA Description:: + -- @@ -192,7 +194,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.encryption +=== .spec.encryption Description:: + -- @@ -216,7 +218,7 @@ Type:: 1. secrets 2. configmaps 3. routes.route.openshift.io 4. oauthaccesstokens.oauth.openshift.io 5. oauthauthorizetokens.oauth.openshift.io |=== -..spec.servingCerts +=== .spec.servingCerts Description:: + -- @@ -242,7 +244,7 @@ Type:: | APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate. |=== -..spec.servingCerts.namedCertificates +=== .spec.servingCerts.namedCertificates Description:: + -- @@ -255,7 +257,7 @@ Type:: -..spec.servingCerts.namedCertificates[] +=== .spec.servingCerts.namedCertificates[] Description:: + -- @@ -281,7 +283,7 @@ Type:: | servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data["tls.key"] - TLS private key. - Secret.Data["tls.crt"] - TLS certificate. |=== -..spec.servingCerts.namedCertificates[].servingCertificate +=== .spec.servingCerts.namedCertificates[].servingCertificate Description:: + -- @@ -305,7 +307,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.tlsSecurityProfile +=== .spec.tlsSecurityProfile Description:: + -- @@ -358,7 +360,7 @@ Type:: Note that the Modern profile is currently not supported because it is not yet well adopted by common software libraries. |=== -..status +=== .status Description:: + -- @@ -457,7 +459,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -514,7 +518,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#apiserverlist-config-openshift-io-v1[`APIServerList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.APIServerList[`APIServerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -541,7 +547,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema | |=== @@ -550,7 +556,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 201 - Created +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 202 - Accepted +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -604,7 +616,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -613,7 +625,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -640,7 +656,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -667,7 +685,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -676,7 +694,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -703,7 +723,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema | |=== @@ -712,7 +732,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 201 - Created +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -760,7 +784,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -787,7 +813,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -796,7 +822,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -823,7 +851,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema | |=== @@ -832,7 +860,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer config.openshift.io/v1`] +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 201 - Created +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/authentication-config-openshift-io-v1.adoc b/rest_api/config_apis/authentication-config-openshift-io-v1.adoc index 3d80a8a9a80a..1c6527583478 100644 --- a/rest_api/config_apis/authentication-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/authentication-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="authentication-config-openshift-io-v1"] = Authentication [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -90,7 +92,7 @@ Type:: | deprecatedWebhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator. It's the same as WebhookTokenAuthenticator but it's missing the 'required' validation on KubeConfig field. |=== -..spec.oauthMetadata +=== .spec.oauthMetadata Description:: + -- @@ -114,7 +116,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.webhookTokenAuthenticator +=== .spec.webhookTokenAuthenticator Description:: + -- @@ -141,7 +143,7 @@ Required:: The key "kubeConfig" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. |=== -..spec.webhookTokenAuthenticator.kubeConfig +=== .spec.webhookTokenAuthenticator.kubeConfig Description:: + -- @@ -168,7 +170,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.webhookTokenAuthenticators +=== .spec.webhookTokenAuthenticators Description:: + -- @@ -181,7 +183,7 @@ Type:: -..spec.webhookTokenAuthenticators[] +=== .spec.webhookTokenAuthenticators[] Description:: + -- @@ -203,7 +205,7 @@ Type:: | kubeConfig contains kube config file data which describes how to access the remote webhook service. For further details, see: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication The key "kubeConfig" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. The namespace for this secret is determined by the point of use. |=== -..spec.webhookTokenAuthenticators[].kubeConfig +=== .spec.webhookTokenAuthenticators[].kubeConfig Description:: + -- @@ -227,7 +229,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..status +=== .status Description:: + -- @@ -249,7 +251,7 @@ Type:: | integratedOAuthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for the in-cluster integrated OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This contains the observed value based on cluster state. An explicitly set value in spec.oauthMetadata has precedence over this field. This field has no meaning if authentication spec.type is not set to IntegratedOAuth. The key "oauthMetadata" is used to locate the data. If the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config-managed. |=== -..status.integratedOAuthMetadata +=== .status.integratedOAuthMetadata Description:: + -- @@ -359,7 +361,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -416,7 +420,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#authenticationlist-config-openshift-io-v1[`AuthenticationList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.AuthenticationList[`AuthenticationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -443,7 +449,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema | |=== @@ -452,7 +458,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 202 - Accepted +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== @@ -506,7 +518,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -515,7 +527,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -542,7 +558,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -569,7 +587,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -578,7 +596,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -605,7 +625,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema | |=== @@ -614,7 +634,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== @@ -662,7 +686,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -689,7 +715,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -698,7 +724,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -725,7 +753,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema | |=== @@ -734,7 +762,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication config.openshift.io/v1`] +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/build-config-openshift-io-v1.adoc b/rest_api/config_apis/build-config-openshift-io-v1.adoc index 28cabbfe1ea2..f7a7f2035853 100644 --- a/rest_api/config_apis/build-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/build-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="build-config-openshift-io-v1"] = Build [config.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Required:: | Spec holds user-settable values for the build controller configuration |=== -..spec +=== .spec Description:: + -- @@ -76,7 +78,7 @@ Type:: | BuildOverrides controls override settings for builds |=== -..spec.additionalTrustedCA +=== .spec.additionalTrustedCA Description:: + -- @@ -101,7 +103,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.buildDefaults +=== .spec.buildDefaults Description:: + -- @@ -149,7 +151,7 @@ Type:: | Resources defines resource requirements to execute the build. |=== -..spec.buildDefaults.defaultProxy +=== .spec.buildDefaults.defaultProxy Description:: + -- @@ -177,7 +179,7 @@ Type:: | `noProxy` | `string` -| noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in an env var. +| noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var. | `readinessEndpoints` | `array (string)` @@ -190,7 +192,7 @@ Type:: apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |=== -..spec.buildDefaults.defaultProxy.trustedCA +=== .spec.buildDefaults.defaultProxy.trustedCA Description:: + -- @@ -216,7 +218,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.buildDefaults.env +=== .spec.buildDefaults.env Description:: + -- @@ -229,7 +231,7 @@ Type:: -..spec.buildDefaults.env[] +=== .spec.buildDefaults.env[] Description:: + -- @@ -254,14 +256,14 @@ Required:: | `value` | `string` -| Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". | `valueFrom` | `object` | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.buildDefaults.env[].valueFrom +=== .spec.buildDefaults.env[].valueFrom Description:: + -- @@ -295,7 +297,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.buildDefaults.env[].valueFrom.configMapKeyRef +=== .spec.buildDefaults.env[].valueFrom.configMapKeyRef Description:: + -- @@ -327,7 +329,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.buildDefaults.env[].valueFrom.fieldRef +=== .spec.buildDefaults.env[].valueFrom.fieldRef Description:: + -- @@ -355,7 +357,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.buildDefaults.env[].valueFrom.resourceFieldRef +=== .spec.buildDefaults.env[].valueFrom.resourceFieldRef Description:: + -- @@ -387,7 +389,7 @@ Required:: | Required: resource to select |=== -..spec.buildDefaults.env[].valueFrom.secretKeyRef +=== .spec.buildDefaults.env[].valueFrom.secretKeyRef Description:: + -- @@ -419,7 +421,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.buildDefaults.gitProxy +=== .spec.buildDefaults.gitProxy Description:: + -- @@ -447,7 +449,7 @@ Type:: | `noProxy` | `string` -| noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in an env var. +| noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var. | `readinessEndpoints` | `array (string)` @@ -460,7 +462,7 @@ Type:: apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |=== -..spec.buildDefaults.gitProxy.trustedCA +=== .spec.buildDefaults.gitProxy.trustedCA Description:: + -- @@ -486,7 +488,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.buildDefaults.imageLabels +=== .spec.buildDefaults.imageLabels Description:: + -- @@ -499,7 +501,7 @@ Type:: -..spec.buildDefaults.imageLabels[] +=== .spec.buildDefaults.imageLabels[] Description:: + -- @@ -525,7 +527,7 @@ Type:: | Value defines the literal value of the label. |=== -..spec.buildDefaults.resources +=== .spec.buildDefaults.resources Description:: + -- @@ -551,7 +553,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.buildOverrides +=== .spec.buildOverrides Description:: + -- @@ -593,7 +595,7 @@ Type:: | The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . |=== -..spec.buildOverrides.imageLabels +=== .spec.buildOverrides.imageLabels Description:: + -- @@ -606,7 +608,7 @@ Type:: -..spec.buildOverrides.imageLabels[] +=== .spec.buildOverrides.imageLabels[] Description:: + -- @@ -632,7 +634,7 @@ Type:: | Value defines the literal value of the label. |=== -..spec.buildOverrides.tolerations +=== .spec.buildOverrides.tolerations Description:: + -- @@ -645,7 +647,7 @@ Type:: -..spec.buildOverrides.tolerations[] +=== .spec.buildOverrides.tolerations[] Description:: + -- @@ -769,7 +771,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -826,7 +830,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildlist-config-openshift-io-v1[`BuildList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.BuildList[`BuildList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -853,7 +859,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema | |=== @@ -862,7 +868,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 202 - Accepted +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== @@ -916,7 +928,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -925,7 +937,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -952,7 +968,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -979,7 +997,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -988,7 +1006,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1015,7 +1035,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema | |=== @@ -1024,7 +1044,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== @@ -1072,7 +1096,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1099,7 +1125,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1108,7 +1134,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1135,7 +1163,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema | |=== @@ -1144,7 +1172,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build config.openshift.io/v1`] +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/clusteroperator-config-openshift-io-v1.adoc b/rest_api/config_apis/clusteroperator-config-openshift-io-v1.adoc index ed4411e0a80c..4e6440231589 100644 --- a/rest_api/config_apis/clusteroperator-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/clusteroperator-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusteroperator-config-openshift-io-v1"] = ClusterOperator [config.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem. |=== -..spec +=== .spec Description:: + -- @@ -60,7 +62,7 @@ Type:: -..status +=== .status Description:: + -- @@ -106,7 +108,7 @@ Type:: | |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -119,7 +121,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -161,7 +163,7 @@ Required:: | type specifies the aspect reported by this condition. |=== -..status.relatedObjects +=== .status.relatedObjects Description:: + -- @@ -174,7 +176,7 @@ Type:: -..status.relatedObjects[] +=== .status.relatedObjects[] Description:: + -- @@ -212,7 +214,7 @@ Required:: | resource of the referent. |=== -..status.versions +=== .status.versions Description:: + -- @@ -225,7 +227,7 @@ Type:: -..status.versions[] +=== .status.versions[] Description:: + -- @@ -340,7 +342,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -397,7 +401,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusteroperatorlist-config-openshift-io-v1[`ClusterOperatorList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ClusterOperatorList[`ClusterOperatorList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -424,7 +430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema | |=== @@ -433,7 +439,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 201 - Created +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 202 - Accepted +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== @@ -487,7 +499,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -496,7 +508,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -523,7 +539,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -550,7 +568,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -559,7 +577,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -586,7 +606,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema | |=== @@ -595,7 +615,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 201 - Created +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== @@ -643,7 +667,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -670,7 +696,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -679,7 +705,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -706,7 +734,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema | |=== @@ -715,7 +743,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator config.openshift.io/v1`] +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 201 - Created +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`ClusterOperator`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc b/rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc index 621a9ac75690..d8a53fb4725f 100644 --- a/rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterversion-config-openshift-io-v1"] = ClusterVersion [config.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | status contains information about the available updates and any in-progress updates. |=== -..spec +=== .spec Description:: + -- @@ -92,7 +94,7 @@ Required:: | upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region. |=== -..spec.desiredUpdate +=== .spec.desiredUpdate Description:: + -- @@ -124,7 +126,7 @@ Type:: | version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified. |=== -..spec.overrides +=== .spec.overrides Description:: + -- @@ -137,7 +139,7 @@ Type:: -..spec.overrides[] +=== .spec.overrides[] Description:: + -- @@ -181,7 +183,7 @@ Required:: | unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false |=== -..status +=== .status Description:: + -- @@ -235,7 +237,7 @@ Required:: | versionHash is a fingerprint of the content that the cluster will be updated with. It is used by the operator to avoid unnecessary work and is for internal use only. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -248,7 +250,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -290,7 +292,7 @@ Required:: | type specifies the aspect reported by this condition. |=== -..status.desired +=== .status.desired Description:: + -- @@ -324,7 +326,7 @@ Type:: | version is a semantic versioning identifying the update version. When this field is part of spec, version is optional if image is specified. |=== -..status.history +=== .status.history Description:: + -- @@ -337,7 +339,7 @@ Type:: -..status.history[] +=== .status.history[] Description:: + -- @@ -470,7 +472,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -527,7 +531,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterversionlist-config-openshift-io-v1[`ClusterVersionList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ClusterVersionList[`ClusterVersionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -554,7 +560,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema | |=== @@ -563,7 +569,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 201 - Created +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 202 - Accepted +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== @@ -617,7 +629,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -626,7 +638,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -653,7 +669,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -680,7 +698,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -689,7 +707,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -716,7 +736,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema | |=== @@ -725,7 +745,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 201 - Created +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== @@ -773,7 +797,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -800,7 +826,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -809,7 +835,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -836,7 +864,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema | |=== @@ -845,7 +873,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion config.openshift.io/v1`] +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 201 - Created +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`ClusterVersion`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/config-apis-index.adoc b/rest_api/config_apis/config-apis-index.adoc index 546d42c48f88..ebd139a06ac7 100644 --- a/rest_api/config_apis/config-apis-index.adoc +++ b/rest_api/config_apis/config-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="config-apis"] = Config APIs ifdef::product-title[] @@ -122,6 +124,18 @@ Image governs policies related to imagestream imports and runtime configuration Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- +Type:: + `object` + +== ImageContentPolicy [config.openshift.io/v1] + +Description:: ++ +-- +ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +-- + Type:: `object` diff --git a/rest_api/config_apis/console-config-openshift-io-v1.adoc b/rest_api/config_apis/console-config-openshift-io-v1.adoc index 2f73ef4f3d85..c5babd9cb9f1 100644 --- a/rest_api/config_apis/console-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/console-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="console-config-openshift-io-v1"] = Console [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -70,7 +72,7 @@ Type:: | ConsoleAuthentication defines a list of optional configuration for console authentication. |=== -..spec.authentication +=== .spec.authentication Description:: + -- @@ -92,7 +94,7 @@ Type:: | An optional, absolute URL to redirect web browsers to after logging out of the console. If not specified, it will redirect to the default login page. This is required when using an identity provider that supports single sign-on (SSO) such as: - OpenID (Keycloak, Azure) - RequestHeader (GSSAPI, SSPI, SAML) - OAuth (GitHub, GitLab, Google) Logging out of the console will destroy the user's token. The logoutRedirect provides the user the option to perform single logout (SLO) through the identity provider to destroy their single sign-on session. |=== -..status +=== .status Description:: + -- @@ -200,7 +202,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -257,7 +261,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolelist-config-openshift-io-v1[`ConsoleList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ConsoleList[`ConsoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -284,7 +290,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema | |=== @@ -293,7 +299,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 202 - Accepted +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== @@ -347,7 +359,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -356,7 +368,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +399,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +428,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -419,7 +437,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -446,7 +466,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema | |=== @@ -455,7 +475,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== @@ -503,7 +527,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -530,7 +556,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -539,7 +565,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -566,7 +594,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema | |=== @@ -575,7 +603,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console config.openshift.io/v1`] +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/dns-config-openshift-io-v1.adoc b/rest_api/config_apis/dns-config-openshift-io-v1.adoc index 0a177c453d9c..7b56cb36ff5c 100644 --- a/rest_api/config_apis/dns-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/dns-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="dns-config-openshift-io-v1"] = DNS [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -84,7 +86,7 @@ Type:: Once set, this field cannot be changed. |=== -..spec.privateZone +=== .spec.privateZone Description:: + -- @@ -116,7 +118,7 @@ Type:: [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options |=== -..spec.publicZone +=== .spec.publicZone Description:: + -- @@ -148,7 +150,7 @@ Type:: [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options |=== -..status +=== .status Description:: + -- @@ -247,7 +249,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -304,7 +308,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#dnslist-config-openshift-io-v1[`DNSList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.DNSList[`DNSList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -331,7 +337,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema | |=== @@ -340,7 +346,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 202 - Accepted +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== @@ -394,7 +406,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -403,7 +415,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -430,7 +446,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -457,7 +475,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -466,7 +484,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -493,7 +513,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema | |=== @@ -502,7 +522,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== @@ -550,7 +574,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -577,7 +603,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -586,7 +612,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -613,7 +641,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema | |=== @@ -622,7 +650,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS config.openshift.io/v1`] +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/featuregate-config-openshift-io-v1.adoc b/rest_api/config_apis/featuregate-config-openshift-io-v1.adoc index 8da10e9e6f17..589d5de80c50 100644 --- a/rest_api/config_apis/featuregate-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/featuregate-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="featuregate-config-openshift-io-v1"] = FeatureGate [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -74,7 +76,7 @@ Type:: | featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone. |=== -..status +=== .status Description:: + -- @@ -173,7 +175,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -230,7 +234,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#featuregatelist-config-openshift-io-v1[`FeatureGateList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.FeatureGateList[`FeatureGateList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -257,7 +263,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema | |=== @@ -266,7 +272,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 201 - Created +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 202 - Accepted +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== @@ -320,7 +332,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -329,7 +341,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -356,7 +372,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +401,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -392,7 +410,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -419,7 +439,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema | |=== @@ -428,7 +448,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 201 - Created +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== @@ -476,7 +500,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -503,7 +529,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -512,7 +538,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +567,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema | |=== @@ -548,7 +576,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate config.openshift.io/v1`] +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 201 - Created +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`FeatureGate`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc b/rest_api/config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc index ad77c4cd5479..3596530a39a0 100644 --- a/rest_api/config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc +++ b/rest_api/config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="helmchartrepository-helm-openshift-io-v1beta1"] = HelmChartRepository [helm.openshift.io/v1beta1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | Observed status of the repository within the cluster.. |=== -..spec +=== .spec Description:: + -- @@ -82,7 +84,7 @@ Type:: | Optional associated human readable repository name, it can be used by UI for displaying purposes |=== -..spec.connectionConfig +=== .spec.connectionConfig Description:: + -- @@ -112,7 +114,7 @@ Type:: | Chart repository URL |=== -..spec.connectionConfig.ca +=== .spec.connectionConfig.ca Description:: + -- @@ -136,7 +138,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.connectionConfig.tlsClientConfig +=== .spec.connectionConfig.tlsClientConfig Description:: + -- @@ -160,7 +162,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..status +=== .status Description:: + -- @@ -187,7 +189,7 @@ Type:: // other fields } |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -200,7 +202,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -335,7 +337,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -392,7 +396,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#helmchartrepositorylist-helm-openshift-io-v1beta1[`HelmChartRepositoryList helm.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.helm.v1beta1.HelmChartRepositoryList[`HelmChartRepositoryList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -419,7 +425,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema | |=== @@ -428,7 +434,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 201 - Created +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 202 - Accepted +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== @@ -482,7 +494,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -491,7 +503,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -518,7 +534,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -545,7 +563,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -554,7 +572,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -581,7 +601,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema | |=== @@ -590,7 +610,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 201 - Created +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== @@ -638,7 +662,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -665,7 +691,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -674,7 +700,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -701,7 +729,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema | |=== @@ -710,7 +738,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository helm.openshift.io/v1beta1`] +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 201 - Created +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`HelmChartRepository`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/image-config-openshift-io-v1.adoc b/rest_api/config_apis/image-config-openshift-io-v1.adoc index 22b0078acdbf..3ea30f8f5378 100644 --- a/rest_api/config_apis/image-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/image-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="image-config-openshift-io-v1"] = Image [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Type:: | registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access). It does not contain configuration for the internal cluster registry. |=== -..spec.additionalTrustedCA +=== .spec.additionalTrustedCA Description:: + -- @@ -110,7 +112,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.allowedRegistriesForImport +=== .spec.allowedRegistriesForImport Description:: + -- @@ -123,7 +125,7 @@ Type:: -..spec.allowedRegistriesForImport[] +=== .spec.allowedRegistriesForImport[] Description:: + -- @@ -149,7 +151,7 @@ Type:: | insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure. |=== -..spec.registrySources +=== .spec.registrySources Description:: + -- @@ -185,7 +187,7 @@ Type:: | insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections. |=== -..status +=== .status Description:: + -- @@ -297,7 +299,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -354,7 +358,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagelist-config-openshift-io-v1[`ImageList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ImageList[`ImageList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -381,7 +387,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema | |=== @@ -390,7 +396,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 201 - Created +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 202 - Accepted +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== @@ -444,7 +456,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -453,7 +465,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -480,7 +496,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -507,7 +525,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -516,7 +534,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -543,7 +563,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema | |=== @@ -552,7 +572,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 201 - Created +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== @@ -600,7 +624,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -627,7 +653,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -636,7 +662,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -663,7 +691,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema | |=== @@ -672,7 +700,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image config.openshift.io/v1`] +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 201 - Created +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/imagecontentpolicy-config-openshift-io-v1.adoc b/rest_api/config_apis/imagecontentpolicy-config-openshift-io-v1.adoc new file mode 100644 index 000000000000..b065bb2359ea --- /dev/null +++ b/rest_api/config_apis/imagecontentpolicy-config-openshift-io-v1.adoc @@ -0,0 +1,620 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="imagecontentpolicy-config-openshift-io-v1"] += ImageContentPolicy [config.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +-- + +Type:: + `object` + +Required:: + - `spec` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| spec holds user settable values for configuration + +|=== +=== .spec +Description:: ++ +-- +spec holds user settable values for configuration +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `repositoryDigestMirrors` +| `array` +| repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To pull image from mirrors by tags, should set the "allowMirrorByTags". + Each “source” repository is treated independently; configurations for different “source” repositories don’t interact. + If the "mirrors" is not specified, the image will continue to be pulled from the specified repository in the pull spec. + When multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. + +| `repositoryDigestMirrors[]` +| `object` +| RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config. + +|=== +=== .spec.repositoryDigestMirrors +Description:: ++ +-- +repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To pull image from mirrors by tags, should set the "allowMirrorByTags". + Each “source” repository is treated independently; configurations for different “source” repositories don’t interact. + If the "mirrors" is not specified, the image will continue to be pulled from the specified repository in the pull spec. + When multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. +-- + +Type:: + `array` + + + + +=== .spec.repositoryDigestMirrors[] +Description:: ++ +-- +RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config. +-- + +Type:: + `object` + +Required:: + - `source` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowMirrorByTags` +| `boolean` +| allowMirrorByTags if true, the mirrors can be used to pull the images that are referenced by their tags. Default is false, the mirrors only work when pulling the images that are referenced by their digests. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Forcing digest-pulls for mirrors avoids that issue. + +| `mirrors` +| `array (string)` +| mirrors is zero or more repositories that may also contain the same images. If the "mirrors" is not specified, the image will continue to be pulled from the specified repository in the pull spec. No mirror will be configured. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. Other cluster configuration, including (but not limited to) other repositoryDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. + +| `source` +| `string` +| source is the repository that users refer to, e.g. in image pull specifications. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/config.openshift.io/v1/imagecontentpolicies` +- `DELETE`: delete collection of ImageContentPolicy +- `GET`: list objects of kind ImageContentPolicy +- `POST`: create an ImageContentPolicy +* `/apis/config.openshift.io/v1/imagecontentpolicies/{name}` +- `DELETE`: delete an ImageContentPolicy +- `GET`: read the specified ImageContentPolicy +- `PATCH`: partially update the specified ImageContentPolicy +- `PUT`: replace the specified ImageContentPolicy +* `/apis/config.openshift.io/v1/imagecontentpolicies/{name}/status` +- `GET`: read status of the specified ImageContentPolicy +- `PATCH`: partially update status of the specified ImageContentPolicy +- `PUT`: replace status of the specified ImageContentPolicy + + +=== /apis/config.openshift.io/v1/imagecontentpolicies + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.openshift.config.v1.ImageContentPolicyList[`ImageContentPolicyList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create an ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 201 - Created +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 202 - Accepted +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/config.openshift.io/v1/imagecontentpolicies/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ImageContentPolicy +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete an ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 201 - Created +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/config.openshift.io/v1/imagecontentpolicies/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ImageContentPolicy +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified ImageContentPolicy + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 201 - Created +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`ImageContentPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc b/rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc index 152204b85057..47cc2ccb2257 100644 --- a/rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="infrastructure-config-openshift-io-v1"] = Infrastructure [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -75,7 +77,7 @@ Type:: | platformSpec holds desired information specific to the underlying infrastructure provider. |=== -..spec.cloudConfig +=== .spec.cloudConfig Description:: + -- @@ -102,7 +104,7 @@ Type:: | |=== -..spec.platformSpec +=== .spec.platformSpec Description:: + -- @@ -119,6 +121,10 @@ Type:: |=== | Property | Type | Description +| `alibabaCloud` +| `object` +| AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. + | `aws` | `object` | AWS contains settings specific to the Amazon Web Services infrastructure provider. @@ -155,16 +161,33 @@ Type:: | `object` | Ovirt contains settings specific to the oVirt infrastructure provider. +| `powervs` +| `object` +| PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. + | `type` | `string` -| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. +| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. | `vsphere` | `object` | VSphere contains settings specific to the VSphere infrastructure provider. |=== -..spec.platformSpec.aws +=== .spec.platformSpec.alibabaCloud +Description:: ++ +-- +AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. +-- + +Type:: + `object` + + + + +=== .spec.platformSpec.aws Description:: + -- @@ -190,7 +213,7 @@ Type:: | AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |=== -..spec.platformSpec.aws.serviceEndpoints +=== .spec.platformSpec.aws.serviceEndpoints Description:: + -- @@ -203,7 +226,7 @@ Type:: -..spec.platformSpec.aws.serviceEndpoints[] +=== .spec.platformSpec.aws.serviceEndpoints[] Description:: + -- @@ -229,7 +252,7 @@ Type:: | url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |=== -..spec.platformSpec.azure +=== .spec.platformSpec.azure Description:: + -- @@ -242,7 +265,7 @@ Type:: -..spec.platformSpec.baremetal +=== .spec.platformSpec.baremetal Description:: + -- @@ -255,7 +278,7 @@ Type:: -..spec.platformSpec.equinixMetal +=== .spec.platformSpec.equinixMetal Description:: + -- @@ -268,7 +291,7 @@ Type:: -..spec.platformSpec.gcp +=== .spec.platformSpec.gcp Description:: + -- @@ -281,7 +304,7 @@ Type:: -..spec.platformSpec.ibmcloud +=== .spec.platformSpec.ibmcloud Description:: + -- @@ -294,7 +317,7 @@ Type:: -..spec.platformSpec.kubevirt +=== .spec.platformSpec.kubevirt Description:: + -- @@ -307,7 +330,7 @@ Type:: -..spec.platformSpec.openstack +=== .spec.platformSpec.openstack Description:: + -- @@ -320,7 +343,7 @@ Type:: -..spec.platformSpec.ovirt +=== .spec.platformSpec.ovirt Description:: + -- @@ -333,7 +356,20 @@ Type:: -..spec.platformSpec.vsphere +=== .spec.platformSpec.powervs +Description:: ++ +-- +PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. +-- + +Type:: + `object` + + + + +=== .spec.platformSpec.vsphere Description:: + -- @@ -346,7 +382,7 @@ Type:: -..status +=== .status Description:: + -- @@ -397,7 +433,7 @@ Type:: | platformStatus holds status information specific to the underlying infrastructure provider. |=== -..status.platformStatus +=== .status.platformStatus Description:: + -- @@ -414,6 +450,10 @@ Type:: |=== | Property | Type | Description +| `alibabaCloud` +| `object` +| AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. + | `aws` | `object` | AWS contains settings specific to the Amazon Web Services infrastructure provider. @@ -450,9 +490,13 @@ Type:: | `object` | Ovirt contains settings specific to the oVirt infrastructure provider. +| `powervs` +| `object` +| PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider. + | `type` | `string` -| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. +| type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. This value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set. | `vsphere` @@ -460,7 +504,86 @@ Type:: | VSphere contains settings specific to the VSphere infrastructure provider. |=== -..status.platformStatus.aws +=== .status.platformStatus.alibabaCloud +Description:: ++ +-- +AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. +-- + +Type:: + `object` + +Required:: + - `region` + - `resourceGroupID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `region` +| `string` +| region specifies the region for Alibaba Cloud resources created for the cluster. + +| `resourceGroupID` +| `string` +| resourceGroupID is the ID of the resource group for the cluster. + +| `resourceTags` +| `array` +| resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster. + +| `resourceTags[]` +| `object` +| AlibabaCloudResourceTag is the set of tags to add to apply to resources. + +|=== +=== .status.platformStatus.alibabaCloud.resourceTags +Description:: ++ +-- +resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster. +-- + +Type:: + `array` + + + + +=== .status.platformStatus.alibabaCloud.resourceTags[] +Description:: ++ +-- +AlibabaCloudResourceTag is the set of tags to add to apply to resources. +-- + +Type:: + `object` + +Required:: + - `key` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| key is the key of the tag. + +| `value` +| `string` +| value is the value of the tag. + +|=== +=== .status.platformStatus.aws Description:: + -- @@ -498,7 +621,7 @@ Type:: | AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |=== -..status.platformStatus.aws.resourceTags +=== .status.platformStatus.aws.resourceTags Description:: + -- @@ -511,7 +634,7 @@ Type:: -..status.platformStatus.aws.resourceTags[] +=== .status.platformStatus.aws.resourceTags[] Description:: + -- @@ -540,7 +663,7 @@ Required:: | value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services. |=== -..status.platformStatus.aws.serviceEndpoints +=== .status.platformStatus.aws.serviceEndpoints Description:: + -- @@ -553,7 +676,7 @@ Type:: -..status.platformStatus.aws.serviceEndpoints[] +=== .status.platformStatus.aws.serviceEndpoints[] Description:: + -- @@ -579,7 +702,7 @@ Type:: | url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |=== -..status.platformStatus.azure +=== .status.platformStatus.azure Description:: + -- @@ -613,7 +736,7 @@ Type:: | resourceGroupName is the Resource Group for new Azure resources created for the cluster. |=== -..status.platformStatus.baremetal +=== .status.platformStatus.baremetal Description:: + -- @@ -643,7 +766,7 @@ Type:: | nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster. |=== -..status.platformStatus.equinixMetal +=== .status.platformStatus.equinixMetal Description:: + -- @@ -669,7 +792,7 @@ Type:: | ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names. |=== -..status.platformStatus.gcp +=== .status.platformStatus.gcp Description:: + -- @@ -695,7 +818,7 @@ Type:: | region holds the region for new GCP resources created for the cluster. |=== -..status.platformStatus.ibmcloud +=== .status.platformStatus.ibmcloud Description:: + -- @@ -729,7 +852,7 @@ Type:: | ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. |=== -..status.platformStatus.kubevirt +=== .status.platformStatus.kubevirt Description:: + -- @@ -755,7 +878,7 @@ Type:: | ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names. |=== -..status.platformStatus.openstack +=== .status.platformStatus.openstack Description:: + -- @@ -789,7 +912,7 @@ Type:: | nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster. |=== -..status.platformStatus.ovirt +=== .status.platformStatus.ovirt Description:: + -- @@ -819,7 +942,87 @@ Type:: | deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release. |=== -..status.platformStatus.vsphere +=== .status.platformStatus.powervs +Description:: ++ +-- +PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `cisInstanceCRN` +| `string` +| CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain + +| `region` +| `string` +| region holds the default Power VS region for new Power VS resources created by the cluster. + +| `serviceEndpoints` +| `array` +| serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service. + +| `serviceEndpoints[]` +| `object` +| PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services. + +| `zone` +| `string` +| zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported + +|=== +=== .status.platformStatus.powervs.serviceEndpoints +Description:: ++ +-- +serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service. +-- + +Type:: + `array` + + + + +=== .status.platformStatus.powervs.serviceEndpoints[] +Description:: ++ +-- +PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services. +-- + +Type:: + `object` + +Required:: + - `name` + - `url` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| name is the name of the Power VS service. + +| `url` +| `string` +| url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. + +|=== +=== .status.platformStatus.vsphere Description:: + -- @@ -935,7 +1138,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -992,7 +1197,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#infrastructurelist-config-openshift-io-v1[`InfrastructureList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.InfrastructureList[`InfrastructureList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1019,7 +1226,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema | |=== @@ -1028,7 +1235,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 201 - Created +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 202 - Accepted +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== @@ -1082,7 +1295,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1091,7 +1304,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1118,7 +1335,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1145,7 +1364,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1154,7 +1373,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1181,7 +1402,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema | |=== @@ -1190,7 +1411,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 201 - Created +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== @@ -1238,7 +1463,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1265,7 +1492,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1274,7 +1501,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1301,7 +1530,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema | |=== @@ -1310,7 +1539,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure config.openshift.io/v1`] +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 201 - Created +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`Infrastructure`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/ingress-config-openshift-io-v1.adoc b/rest_api/config_apis/ingress-config-openshift-io-v1.adoc index 5997c78894a6..b17447eb7e15 100644 --- a/rest_api/config_apis/ingress-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/ingress-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="ingress-config-openshift-io-v1"] = Ingress [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -97,7 +99,7 @@ Type:: | |=== -..spec.componentRoutes +=== .spec.componentRoutes Description:: + -- @@ -111,7 +113,7 @@ Type:: -..spec.componentRoutes[] +=== .spec.componentRoutes[] Description:: + -- @@ -151,7 +153,7 @@ Required:: | servingCertKeyPairSecret is a reference to a secret of type `kubernetes.io/tls` in the openshift-config namespace. The serving cert/key pair must match and will be used by the operator to fulfill the intent of serving with this name. If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. |=== -..spec.componentRoutes[].servingCertKeyPairSecret +=== .spec.componentRoutes[].servingCertKeyPairSecret Description:: + -- @@ -175,7 +177,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.requiredHSTSPolicies +=== .spec.requiredHSTSPolicies Description:: + -- @@ -192,7 +194,7 @@ Type:: -..spec.requiredHSTSPolicies[] +=== .spec.requiredHSTSPolicies[] Description:: + -- @@ -202,6 +204,8 @@ Description:: Type:: `object` +Required:: + - `domainPatterns` @@ -212,7 +216,7 @@ Type:: | `domainPatterns` | `array (string)` | domainPatterns is a list of domains for which the desired HSTS annotations are required. If domainPatterns is specified and a route is created with a spec.host matching one of the domains, the route must specify the HSTS Policy components described in the matching RequiredHSTSPolicy. - The use of wildcards is allowed like this: *.foo.com matches everything under foo.com. foo.com only matches foo.com, so to cover foo.com and everything under it, you must specify *both*. kubebuilder:validation:MinLength=1 + The use of wildcards is allowed like this: *.foo.com matches everything under foo.com. foo.com only matches foo.com, so to cover foo.com and everything under it, you must specify *both*. | `includeSubDomainsPolicy` | `string` @@ -231,7 +235,7 @@ Type:: | preloadPolicy directs the client to include hosts in its host preload list so that it never needs to do an initial load to get the HSTS header (note that this is not defined in RFC 6797 and is therefore client implementation-dependent). |=== -..spec.requiredHSTSPolicies[].maxAge +=== .spec.requiredHSTSPolicies[].maxAge Description:: + -- @@ -250,14 +254,14 @@ Type:: | `largestMaxAge` | `integer` -| The largest allowed value (in seconds) of the RequiredHSTSPolicy max-age This value can be left unspecified, in which case no upper limit is enforced. kubebuilder:validation:minimum=0:maximum=2147483647 +| The largest allowed value (in seconds) of the RequiredHSTSPolicy max-age This value can be left unspecified, in which case no upper limit is enforced. | `smallestMaxAge` | `integer` -| The smallest allowed value (in seconds) of the RequiredHSTSPolicy max-age Setting max-age=0 allows the deletion of an existing HSTS header from a host. This is a necessary tool for administrators to quickly correct mistakes. This value can be left unspecified, in which case no lower limit is enforced. kubebuilder:validation:minimum=0:maximum=2147483647 +| The smallest allowed value (in seconds) of the RequiredHSTSPolicy max-age Setting max-age=0 allows the deletion of an existing HSTS header from a host. This is a necessary tool for administrators to quickly correct mistakes. This value can be left unspecified, in which case no lower limit is enforced. |=== -..spec.requiredHSTSPolicies[].namespaceSelector +=== .spec.requiredHSTSPolicies[].namespaceSelector Description:: + -- @@ -287,7 +291,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions +=== .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions Description:: + -- @@ -300,7 +304,7 @@ Type:: -..spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions[] +=== .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions[] Description:: + -- @@ -333,7 +337,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..status +=== .status Description:: + -- @@ -359,7 +363,7 @@ Type:: | ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate. |=== -..status.componentRoutes +=== .status.componentRoutes Description:: + -- @@ -372,7 +376,7 @@ Type:: -..status.componentRoutes[] +=== .status.componentRoutes[] Description:: + -- @@ -438,7 +442,7 @@ Required:: | ObjectReference contains enough information to let you inspect or modify the referred object. |=== -..status.componentRoutes[].conditions +=== .status.componentRoutes[].conditions Description:: + -- @@ -455,7 +459,7 @@ Type:: -..status.componentRoutes[].conditions[] +=== .status.componentRoutes[].conditions[] Description:: + -- @@ -504,7 +508,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..status.componentRoutes[].relatedObjects +=== .status.componentRoutes[].relatedObjects Description:: + -- @@ -517,7 +521,7 @@ Type:: -..status.componentRoutes[].relatedObjects[] +=== .status.componentRoutes[].relatedObjects[] Description:: + -- @@ -641,7 +645,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -698,7 +704,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingresslist-config-openshift-io-v1[`IngressList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.IngressList[`IngressList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -725,7 +733,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema | |=== @@ -734,7 +742,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 201 - Created +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 202 - Accepted +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== @@ -788,7 +802,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -797,7 +811,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -824,7 +842,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -851,7 +871,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -860,7 +880,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -887,7 +909,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema | |=== @@ -896,7 +918,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 201 - Created +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== @@ -944,7 +970,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -971,7 +999,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -980,7 +1008,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1007,7 +1037,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema | |=== @@ -1016,7 +1046,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress config.openshift.io/v1`] +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 201 - Created +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/network-config-openshift-io-v1.adoc b/rest_api/config_apis/network-config-openshift-io-v1.adoc index ef1c07ceccfa..2a15f4c25a00 100644 --- a/rest_api/config_apis/network-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/network-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="network-config-openshift-io-v1"] = Network [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -90,7 +92,7 @@ Type:: | The port range allowed for Services of type NodePort. If not specified, the default of 30000-32767 will be used. Such Services without a NodePort specified will have one automatically allocated from this range. This parameter can be updated after the cluster is installed. |=== -..spec.clusterNetwork +=== .spec.clusterNetwork Description:: + -- @@ -103,7 +105,7 @@ Type:: -..spec.clusterNetwork[] +=== .spec.clusterNetwork[] Description:: + -- @@ -129,7 +131,7 @@ Type:: | The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset. |=== -..spec.externalIP +=== .spec.externalIP Description:: + -- @@ -155,7 +157,7 @@ Type:: | policy is a set of restrictions applied to the ExternalIP field. If nil or empty, then ExternalIP is not allowed to be set. |=== -..spec.externalIP.policy +=== .spec.externalIP.policy Description:: + -- @@ -181,7 +183,7 @@ Type:: | rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs. |=== -..status +=== .status Description:: + -- @@ -223,7 +225,7 @@ Type:: | IP address pool for services. Currently, we only support a single entry here. |=== -..status.clusterNetwork +=== .status.clusterNetwork Description:: + -- @@ -236,7 +238,7 @@ Type:: -..status.clusterNetwork[] +=== .status.clusterNetwork[] Description:: + -- @@ -262,7 +264,7 @@ Type:: | The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset. |=== -..status.migration +=== .status.migration Description:: + -- @@ -366,7 +368,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -423,7 +427,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networklist-config-openshift-io-v1[`NetworkList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.NetworkList[`NetworkList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -450,7 +456,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema | |=== @@ -459,7 +465,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 201 - Created +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 202 - Accepted +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== @@ -513,7 +525,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -522,7 +534,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -549,7 +565,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -576,7 +594,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -585,7 +603,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -612,7 +632,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema | |=== @@ -621,7 +641,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network config.openshift.io/v1`] +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 201 - Created +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/oauth-config-openshift-io-v1.adoc b/rest_api/config_apis/oauth-config-openshift-io-v1.adoc index 62cc53c77aeb..a8bddb8bf6e6 100644 --- a/rest_api/config_apis/oauth-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/oauth-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauth-config-openshift-io-v1"] = OAuth [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -82,7 +84,7 @@ Type:: | tokenConfig contains options for authorization and access tokens |=== -..spec.identityProviders +=== .spec.identityProviders Description:: + -- @@ -95,7 +97,7 @@ Type:: -..spec.identityProviders[] +=== .spec.identityProviders[] Description:: + -- @@ -161,7 +163,7 @@ Type:: | type identifies the identity provider type for this entry. |=== -..spec.identityProviders[].basicAuth +=== .spec.identityProviders[].basicAuth Description:: + -- @@ -195,7 +197,7 @@ Type:: | url is the remote URL to connect to |=== -..spec.identityProviders[].basicAuth.ca +=== .spec.identityProviders[].basicAuth.ca Description:: + -- @@ -219,7 +221,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].basicAuth.tlsClientCert +=== .spec.identityProviders[].basicAuth.tlsClientCert Description:: + -- @@ -243,7 +245,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].basicAuth.tlsClientKey +=== .spec.identityProviders[].basicAuth.tlsClientKey Description:: + -- @@ -267,7 +269,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].github +=== .spec.identityProviders[].github Description:: + -- @@ -309,7 +311,7 @@ Type:: | teams optionally restricts which teams are allowed to log in. Format is /. |=== -..spec.identityProviders[].github.ca +=== .spec.identityProviders[].github.ca Description:: + -- @@ -333,7 +335,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].github.clientSecret +=== .spec.identityProviders[].github.clientSecret Description:: + -- @@ -357,7 +359,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].gitlab +=== .spec.identityProviders[].gitlab Description:: + -- @@ -391,7 +393,7 @@ Type:: | url is the oauth server base URL |=== -..spec.identityProviders[].gitlab.ca +=== .spec.identityProviders[].gitlab.ca Description:: + -- @@ -415,7 +417,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].gitlab.clientSecret +=== .spec.identityProviders[].gitlab.clientSecret Description:: + -- @@ -439,7 +441,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].google +=== .spec.identityProviders[].google Description:: + -- @@ -469,7 +471,7 @@ Type:: | hostedDomain is the optional Google App domain (e.g. "mycompany.com") to restrict logins to |=== -..spec.identityProviders[].google.clientSecret +=== .spec.identityProviders[].google.clientSecret Description:: + -- @@ -493,7 +495,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].htpasswd +=== .spec.identityProviders[].htpasswd Description:: + -- @@ -515,7 +517,7 @@ Type:: | fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key "htpasswd" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config. |=== -..spec.identityProviders[].htpasswd.fileData +=== .spec.identityProviders[].htpasswd.fileData Description:: + -- @@ -539,7 +541,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].keystone +=== .spec.identityProviders[].keystone Description:: + -- @@ -577,7 +579,7 @@ Type:: | url is the remote URL to connect to |=== -..spec.identityProviders[].keystone.ca +=== .spec.identityProviders[].keystone.ca Description:: + -- @@ -601,7 +603,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].keystone.tlsClientCert +=== .spec.identityProviders[].keystone.tlsClientCert Description:: + -- @@ -625,7 +627,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].keystone.tlsClientKey +=== .spec.identityProviders[].keystone.tlsClientKey Description:: + -- @@ -649,7 +651,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].ldap +=== .spec.identityProviders[].ldap Description:: + -- @@ -691,7 +693,7 @@ Type:: | url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter |=== -..spec.identityProviders[].ldap.attributes +=== .spec.identityProviders[].ldap.attributes Description:: + -- @@ -725,7 +727,7 @@ Type:: | preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is "uid" |=== -..spec.identityProviders[].ldap.bindPassword +=== .spec.identityProviders[].ldap.bindPassword Description:: + -- @@ -749,7 +751,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].ldap.ca +=== .spec.identityProviders[].ldap.ca Description:: + -- @@ -773,7 +775,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].openID +=== .spec.identityProviders[].openID Description:: + -- @@ -819,7 +821,7 @@ Type:: | issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component. |=== -..spec.identityProviders[].openID.ca +=== .spec.identityProviders[].openID.ca Description:: + -- @@ -843,7 +845,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.identityProviders[].openID.claims +=== .spec.identityProviders[].openID.claims Description:: + -- @@ -864,6 +866,10 @@ Type:: | `array (string)` | email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity +| `groups` +| `array (string)` +| groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user. If multiple claims are specified, the first one with a non-empty value is used. + | `name` | `array (string)` | name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity @@ -873,7 +879,7 @@ Type:: | preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim |=== -..spec.identityProviders[].openID.clientSecret +=== .spec.identityProviders[].openID.clientSecret Description:: + -- @@ -897,7 +903,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.identityProviders[].requestHeader +=== .spec.identityProviders[].requestHeader Description:: + -- @@ -947,7 +953,7 @@ Type:: | preferredUsernameHeaders is the set of headers to check for the preferred username |=== -..spec.identityProviders[].requestHeader.ca +=== .spec.identityProviders[].requestHeader.ca Description:: + -- @@ -971,7 +977,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.templates +=== .spec.templates Description:: + -- @@ -1001,7 +1007,7 @@ Type:: | providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key "providers.html" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config. |=== -..spec.templates.error +=== .spec.templates.error Description:: + -- @@ -1025,7 +1031,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.templates.login +=== .spec.templates.login Description:: + -- @@ -1049,7 +1055,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.templates.providerSelection +=== .spec.templates.providerSelection Description:: + -- @@ -1073,7 +1079,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..spec.tokenConfig +=== .spec.tokenConfig Description:: + -- @@ -1092,7 +1098,8 @@ Type:: | `accessTokenInactivityTimeout` | `string` -| accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as "5m", "1.5h" or "2h45m". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime. +| accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as "5m", "1.5h" or "2h45m". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime. + WARNING: existing tokens' timeout will not be affected (lowered) by changing this value | `accessTokenInactivityTimeoutSeconds` | `integer` @@ -1103,7 +1110,7 @@ Type:: | accessTokenMaxAgeSeconds defines the maximum age of access tokens |=== -..status +=== .status Description:: + -- @@ -1202,7 +1209,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1259,7 +1268,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#oauthlist-config-openshift-io-v1[`OAuthList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.OAuthList[`OAuthList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1286,7 +1297,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema | |=== @@ -1295,7 +1306,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 201 - Created +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 202 - Accepted +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== @@ -1349,7 +1366,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1358,7 +1375,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1385,7 +1406,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1412,7 +1435,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1421,7 +1444,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1448,7 +1473,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema | |=== @@ -1457,7 +1482,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 201 - Created +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== @@ -1505,7 +1534,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1532,7 +1563,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1541,7 +1572,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1568,7 +1601,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema | |=== @@ -1577,7 +1610,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth config.openshift.io/v1`] +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 201 - Created +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`OAuth`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/operatorhub-config-openshift-io-v1.adoc b/rest_api/config_apis/operatorhub-config-openshift-io-v1.adoc index f440ec627837..be8bda4d0a42 100644 --- a/rest_api/config_apis/operatorhub-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/operatorhub-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operatorhub-config-openshift-io-v1"] = OperatorHub [config.openshift.io/v1] ifdef::product-title[] @@ -34,7 +36,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -46,7 +48,7 @@ Type:: | OperatorHubStatus defines the observed state of OperatorHub. The current state of the default hub sources will always be reflected here. |=== -..spec +=== .spec Description:: + -- @@ -76,7 +78,7 @@ Type:: | HubSource is used to specify the hub source and its configuration |=== -..spec.sources +=== .spec.sources Description:: + -- @@ -89,7 +91,7 @@ Type:: -..spec.sources[] +=== .spec.sources[] Description:: + -- @@ -115,7 +117,7 @@ Type:: | name is the name of one of the default hub sources |=== -..status +=== .status Description:: + -- @@ -141,7 +143,7 @@ Type:: | HubSourceStatus is used to reflect the current state of applying the configuration to a default source |=== -..status.sources +=== .status.sources Description:: + -- @@ -154,7 +156,7 @@ Type:: -..status.sources[] +=== .status.sources[] Description:: + -- @@ -274,7 +276,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -331,7 +335,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorhublist-config-openshift-io-v1[`OperatorHubList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.OperatorHubList[`OperatorHubList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -358,7 +364,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema | |=== @@ -367,7 +373,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 201 - Created +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 202 - Accepted +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== @@ -421,7 +433,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -430,7 +442,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -457,7 +473,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -484,7 +502,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -493,7 +511,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -520,7 +540,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema | |=== @@ -529,7 +549,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 201 - Created +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== @@ -577,7 +601,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +630,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -613,7 +639,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -640,7 +668,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema | |=== @@ -649,7 +677,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub config.openshift.io/v1`] +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 201 - Created +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`OperatorHub`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/project-config-openshift-io-v1.adoc b/rest_api/config_apis/project-config-openshift-io-v1.adoc index 9a0d7a98990f..efcdee708baf 100644 --- a/rest_api/config_apis/project-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/project-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="project-config-openshift-io-v1"] = Project [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -74,7 +76,7 @@ Type:: | projectRequestTemplate is the template to use for creating projects in response to projectrequest. This must point to a template in 'openshift-config' namespace. It is optional. If it is not specified, a default template is used. |=== -..spec.projectRequestTemplate +=== .spec.projectRequestTemplate Description:: + -- @@ -96,7 +98,7 @@ Type:: | name is the metadata.name of the referenced project request template |=== -..status +=== .status Description:: + -- @@ -195,7 +197,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -252,7 +256,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#projectlist-config-openshift-io-v1[`ProjectList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ProjectList[`ProjectList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -279,7 +285,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema | |=== @@ -288,7 +294,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 201 - Created +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 202 - Accepted +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== @@ -342,7 +354,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -351,7 +363,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -378,7 +394,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -405,7 +423,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -414,7 +432,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -441,7 +461,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema | |=== @@ -450,7 +470,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 201 - Created +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== @@ -498,7 +522,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -525,7 +551,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -534,7 +560,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -561,7 +589,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema | |=== @@ -570,7 +598,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project config.openshift.io/v1`] +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 201 - Created +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/proxy-config-openshift-io-v1.adoc b/rest_api/config_apis/proxy-config-openshift-io-v1.adoc index 6b0e52767e81..bd3357a46aa6 100644 --- a/rest_api/config_apis/proxy-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/proxy-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="proxy-config-openshift-io-v1"] = Proxy [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -75,7 +77,7 @@ Type:: | `noProxy` | `string` -| noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used. Empty means unset and will not result in an env var. +| noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var. | `readinessEndpoints` | `array (string)` @@ -88,7 +90,7 @@ Type:: apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |=== -..spec.trustedCA +=== .spec.trustedCA Description:: + -- @@ -114,7 +116,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..status +=== .status Description:: + -- @@ -230,7 +232,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -287,7 +291,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#proxylist-config-openshift-io-v1[`ProxyList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.ProxyList[`ProxyList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -314,7 +320,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema | |=== @@ -323,7 +329,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 201 - Created +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 202 - Accepted +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== @@ -377,7 +389,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -386,7 +398,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -413,7 +429,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -440,7 +458,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -449,7 +467,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -476,7 +496,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema | |=== @@ -485,7 +505,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 201 - Created +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== @@ -533,7 +557,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -560,7 +586,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -569,7 +595,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -596,7 +624,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema | |=== @@ -605,7 +633,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy config.openshift.io/v1`] +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 201 - Created +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`Proxy`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/config_apis/scheduler-config-openshift-io-v1.adoc b/rest_api/config_apis/scheduler-config-openshift-io-v1.adoc index 6c5bad249386..ef3b65441cfd 100644 --- a/rest_api/config_apis/scheduler-config-openshift-io-v1.adoc +++ b/rest_api/config_apis/scheduler-config-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="scheduler-config-openshift-io-v1"] = Scheduler [config.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -83,7 +85,7 @@ Type:: Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring" Defaults to "LowNodeUtilization" |=== -..spec.policy +=== .spec.policy Description:: + -- @@ -107,7 +109,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..status +=== .status Description:: + -- @@ -206,7 +208,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -263,7 +267,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#schedulerlist-config-openshift-io-v1[`SchedulerList config.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.config.v1.SchedulerList[`SchedulerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -290,7 +296,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema | |=== @@ -299,7 +305,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 201 - Created +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 202 - Accepted +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== @@ -353,7 +365,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -362,7 +374,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -389,7 +405,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -416,7 +434,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -425,7 +443,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -452,7 +472,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema | |=== @@ -461,7 +481,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 201 - Created +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== @@ -509,7 +533,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +562,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +571,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +600,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema | |=== @@ -581,7 +609,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler config.openshift.io/v1`] +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 201 - Created +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`Scheduler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/console-apis-index.adoc b/rest_api/console_apis/console-apis-index.adoc index 314d56668c99..6a9f9260229c 100644 --- a/rest_api/console_apis/console-apis-index.adoc +++ b/rest_api/console_apis/console-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="console-apis"] = Console APIs ifdef::product-title[] diff --git a/rest_api/console_apis/consoleclidownload-console-openshift-io-v1.adoc b/rest_api/console_apis/consoleclidownload-console-openshift-io-v1.adoc index 04459ff884a5..2839421fe7a4 100644 --- a/rest_api/console_apis/consoleclidownload-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consoleclidownload-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consoleclidownload-console-openshift-io-v1"] = ConsoleCLIDownload [console.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | ConsoleCLIDownloadSpec is the desired cli download configuration. |=== -..spec +=== .spec Description:: + -- @@ -82,7 +84,7 @@ Required:: | |=== -..spec.links +=== .spec.links Description:: + -- @@ -95,7 +97,7 @@ Type:: -..spec.links[] +=== .spec.links[] Description:: + -- @@ -209,7 +211,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -266,7 +270,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consoleclidownloadlist-console-openshift-io-v1[`ConsoleCLIDownloadList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleCLIDownloadList[`ConsoleCLIDownloadList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -293,7 +299,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema | |=== @@ -302,7 +308,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 201 - Created +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 202 - Accepted +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== @@ -356,7 +368,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -365,7 +377,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -392,7 +408,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -419,7 +437,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -428,7 +446,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -455,7 +475,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema | |=== @@ -464,7 +484,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 201 - Created +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== @@ -512,7 +536,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +565,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -548,7 +574,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -575,7 +603,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema | |=== @@ -584,7 +612,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload console.openshift.io/v1`] +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 201 - Created +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`ConsoleCLIDownload`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consoleexternalloglink-console-openshift-io-v1.adoc b/rest_api/console_apis/consoleexternalloglink-console-openshift-io-v1.adoc index 3e0b6182ea80..58dd2f377bcc 100644 --- a/rest_api/console_apis/consoleexternalloglink-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consoleexternalloglink-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consoleexternalloglink-console-openshift-io-v1"] = ConsoleExternalLogLink [console.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page. |=== -..spec +=== .spec Description:: + -- @@ -164,7 +166,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -221,7 +225,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consoleexternalloglinklist-console-openshift-io-v1[`ConsoleExternalLogLinkList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleExternalLogLinkList[`ConsoleExternalLogLinkList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -248,7 +254,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema | |=== @@ -257,7 +263,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 201 - Created +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 202 - Accepted +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== @@ -311,7 +323,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -320,7 +332,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -347,7 +363,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -374,7 +392,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -383,7 +401,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema | |=== @@ -419,7 +439,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 201 - Created +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== @@ -467,7 +491,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -494,7 +520,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -503,7 +529,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -530,7 +558,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema | |=== @@ -539,7 +567,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink console.openshift.io/v1`] +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 201 - Created +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`ConsoleExternalLogLink`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consolelink-console-openshift-io-v1.adoc b/rest_api/console_apis/consolelink-console-openshift-io-v1.adoc index 1604c94f6a6a..5a09be4d77c9 100644 --- a/rest_api/console_apis/consolelink-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consolelink-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consolelink-console-openshift-io-v1"] = ConsoleLink [console.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | ConsoleLinkSpec is the desired console link configuration. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Required:: | text is the display text for the link |=== -..spec.applicationMenu +=== .spec.applicationMenu Description:: + -- @@ -114,7 +116,7 @@ Required:: | section is the section of the application menu in which the link should appear. This can be any text that will appear as a subheading in the application menu dropdown. A new section will be created if the text does not match text of an existing section. |=== -..spec.namespaceDashboard +=== .spec.namespaceDashboard Description:: + -- @@ -140,7 +142,7 @@ Type:: | namespaces is an array of namespace names in which the dashboard link should appear. |=== -..spec.namespaceDashboard.namespaceSelector +=== .spec.namespaceDashboard.namespaceSelector Description:: + -- @@ -170,7 +172,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.namespaceDashboard.namespaceSelector.matchExpressions +=== .spec.namespaceDashboard.namespaceSelector.matchExpressions Description:: + -- @@ -183,7 +185,7 @@ Type:: -..spec.namespaceDashboard.namespaceSelector.matchExpressions[] +=== .spec.namespaceDashboard.namespaceSelector.matchExpressions[] Description:: + -- @@ -302,7 +304,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -359,7 +363,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolelinklist-console-openshift-io-v1[`ConsoleLinkList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleLinkList[`ConsoleLinkList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -386,7 +392,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema | |=== @@ -395,7 +401,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 201 - Created +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 202 - Accepted +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== @@ -449,7 +461,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -458,7 +470,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -485,7 +501,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -512,7 +530,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -521,7 +539,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -548,7 +568,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema | |=== @@ -557,7 +577,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 201 - Created +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== @@ -605,7 +629,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -632,7 +658,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -641,7 +667,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -668,7 +696,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema | |=== @@ -677,7 +705,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink console.openshift.io/v1`] +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 201 - Created +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`ConsoleLink`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consolenotification-console-openshift-io-v1.adoc b/rest_api/console_apis/consolenotification-console-openshift-io-v1.adoc index 7874af2fa337..1afe28ea13d4 100644 --- a/rest_api/console_apis/consolenotification-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consolenotification-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consolenotification-console-openshift-io-v1"] = ConsoleNotification [console.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | ConsoleNotificationSpec is the desired console notification configuration. |=== -..spec +=== .spec Description:: + -- @@ -84,7 +86,7 @@ Required:: | text is the visible text of the notification. |=== -..spec.link +=== .spec.link Description:: + -- @@ -199,7 +201,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -256,7 +260,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolenotificationlist-console-openshift-io-v1[`ConsoleNotificationList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleNotificationList[`ConsoleNotificationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -283,7 +289,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema | |=== @@ -292,7 +298,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 201 - Created +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 202 - Accepted +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== @@ -346,7 +358,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -355,7 +367,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -382,7 +398,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -409,7 +427,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -418,7 +436,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -445,7 +465,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema | |=== @@ -454,7 +474,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 201 - Created +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== @@ -502,7 +526,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -529,7 +555,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -538,7 +564,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -565,7 +593,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema | |=== @@ -574,7 +602,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification console.openshift.io/v1`] +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 201 - Created +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`ConsoleNotification`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc b/rest_api/console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc index 8d613102c5ba..c68b69f2a60f 100644 --- a/rest_api/console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc +++ b/rest_api/console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consoleplugin-console-openshift-io-v1alpha1"] = ConsolePlugin [console.openshift.io/v1alpha1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Required:: | ConsolePluginSpec is the desired plugin configuration. |=== -..spec +=== .spec Description:: + -- @@ -74,7 +76,7 @@ Required:: | service is a Kubernetes Service that exposes the plugin using a deployment with an HTTP server. The Service must use HTTPS and service serving certificate. The console backend will proxy the plugins assets from the Service using the service CA bundle. |=== -..spec.service +=== .spec.service Description:: + -- @@ -195,7 +197,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -252,7 +256,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolepluginlist-console-openshift-io-v1alpha1[`ConsolePluginList console.openshift.io/v1alpha1`] +| xref:../objects/index.adoc#io.openshift.console.v1alpha1.ConsolePluginList[`ConsolePluginList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -279,7 +285,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema | |=== @@ -288,7 +294,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 201 - Created +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 202 - Accepted +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 401 - Unauthorized +| Empty |=== @@ -342,7 +354,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -351,7 +363,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -378,7 +394,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -405,7 +423,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -414,7 +432,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -441,7 +461,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema | |=== @@ -450,7 +470,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin console.openshift.io/v1alpha1`] +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 201 - Created +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`ConsolePlugin`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consolequickstart-console-openshift-io-v1.adoc b/rest_api/console_apis/consolequickstart-console-openshift-io-v1.adoc index 7faf1e087eaf..06ef023826d3 100644 --- a/rest_api/console_apis/consolequickstart-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consolequickstart-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consolequickstart-console-openshift-io-v1"] = ConsoleQuickStart [console.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | ConsoleQuickStartSpec is the desired quick start configuration. |=== -..spec +=== .spec Description:: + -- @@ -120,7 +122,7 @@ Required:: | ConsoleQuickStartTask is a single step in a Quick Start. |=== -..spec.accessReviewResources +=== .spec.accessReviewResources Description:: + -- @@ -133,7 +135,7 @@ Type:: -..spec.accessReviewResources[] +=== .spec.accessReviewResources[] Description:: + -- @@ -179,7 +181,7 @@ Type:: | Version is the API Version of the Resource. "*" means all. |=== -..spec.tasks +=== .spec.tasks Description:: + -- @@ -192,7 +194,7 @@ Type:: -..spec.tasks[] +=== .spec.tasks[] Description:: + -- @@ -229,7 +231,7 @@ Required:: | title describes the task and is displayed as a step heading. |=== -..spec.tasks[].review +=== .spec.tasks[].review Description:: + -- @@ -258,7 +260,7 @@ Required:: | instructions contains steps that user needs to take in order to validate his work after going through a task. (includes markdown) |=== -..spec.tasks[].summary +=== .spec.tasks[].summary Description:: + -- @@ -369,7 +371,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -426,7 +430,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolequickstartlist-console-openshift-io-v1[`ConsoleQuickStartList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleQuickStartList[`ConsoleQuickStartList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -453,7 +459,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema | |=== @@ -462,7 +468,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 201 - Created +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 202 - Accepted +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 401 - Unauthorized +| Empty |=== @@ -516,7 +528,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -525,7 +537,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -552,7 +568,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -579,7 +597,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -588,7 +606,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -615,7 +635,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema | |=== @@ -624,7 +644,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart console.openshift.io/v1`] +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 201 - Created +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`ConsoleQuickStart`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/console_apis/consoleyamlsample-console-openshift-io-v1.adoc b/rest_api/console_apis/consoleyamlsample-console-openshift-io-v1.adoc index 943cb88243e7..9a514da76a97 100644 --- a/rest_api/console_apis/consoleyamlsample-console-openshift-io-v1.adoc +++ b/rest_api/console_apis/consoleyamlsample-console-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="consoleyamlsample-console-openshift-io-v1"] = ConsoleYAMLSample [console.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Required:: | ConsoleYAMLSampleSpec is the desired YAML sample configuration. Samples will appear with their descriptions in a samples sidebar when creating a resources in the web console. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Required:: | yaml is the YAML sample to display. |=== -..spec.targetResource +=== .spec.targetResource Description:: + -- @@ -196,7 +198,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -253,7 +257,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consoleyamlsamplelist-console-openshift-io-v1[`ConsoleYAMLSampleList console.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.console.v1.ConsoleYAMLSampleList[`ConsoleYAMLSampleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -280,7 +286,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema | |=== @@ -289,7 +295,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 201 - Created +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 202 - Accepted +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 401 - Unauthorized +| Empty |=== @@ -343,7 +355,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -352,7 +364,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -379,7 +395,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -406,7 +424,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -415,7 +433,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -442,7 +462,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema | |=== @@ -451,7 +471,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample console.openshift.io/v1`] +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 201 - Created +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`ConsoleYAMLSample`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/extension_apis/apiservice-apiregistration-k8s-io-v1.adoc b/rest_api/extension_apis/apiservice-apiregistration-k8s-io-v1.adoc index 36f096dd8fdb..35fa3ecc89b2 100644 --- a/rest_api/extension_apis/apiservice-apiregistration-k8s-io-v1.adoc +++ b/rest_api/extension_apis/apiservice-apiregistration-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="apiservice-apiregistration-k8s-io-v1"] = APIService [apiregistration.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | APIServiceStatus contains derived information about an API server |=== -..spec +=== .spec Description:: + -- @@ -94,7 +96,7 @@ Required:: | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |=== -..spec.service +=== .spec.service Description:: + -- @@ -124,7 +126,7 @@ Type:: | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |=== -..status +=== .status Description:: + -- @@ -150,7 +152,7 @@ Type:: | APIServiceCondition describes the state of an APIService at a particular point |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -163,7 +165,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -184,7 +186,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transitioned from one status to another. | `message` @@ -213,11 +215,15 @@ The following API endpoints are available: - `DELETE`: delete collection of APIService - `GET`: list or watch objects of kind APIService - `POST`: create an APIService +* `/apis/apiregistration.k8s.io/v1/watch/apiservices` +- `GET`: watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apiregistration.k8s.io/v1/apiservices/{name}` - `DELETE`: delete an APIService - `GET`: read the specified APIService - `PATCH`: partially update the specified APIService - `PUT`: replace the specified APIService +* `/apis/apiregistration.k8s.io/v1/watch/apiservices/{name}` +- `GET`: watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apiregistration.k8s.io/v1/apiservices/{name}/status` - `GET`: read status of the specified APIService - `PATCH`: partially update status of the specified APIService @@ -295,7 +301,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -304,7 +310,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -361,7 +369,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#apiservicelist-apiregistration-k8s-io-v1[`APIServiceList apiregistration.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList[`APIServiceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -388,7 +398,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema | |=== @@ -397,7 +407,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 201 - Created +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 202 - Accepted +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apiregistration.k8s.io/v1/watch/apiservices + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -451,7 +532,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -460,7 +541,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -475,7 +560,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -505,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -514,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 201 - Created +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -541,7 +632,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema | |=== @@ -550,7 +641,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 201 - Created +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apiregistration.k8s.io/v1/watch/apiservices/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the APIService +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -586,7 +754,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -616,7 +786,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -625,7 +795,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 201 - Created +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -652,7 +826,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema | |=== @@ -661,7 +835,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService apiregistration.k8s.io/v1`] +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 201 - Created +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`APIService`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc b/rest_api/extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc index 376e2fd595e5..c5324e47c4d8 100644 --- a/rest_api/extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc +++ b/rest_api/extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="customresourcedefinition-apiextensions-k8s-io-v1"] = CustomResourceDefinition [apiextensions.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition |=== -..spec +=== .spec Description:: + -- @@ -98,7 +100,7 @@ Required:: | CustomResourceDefinitionVersion describes a version for CRD. |=== -..spec.conversion +=== .spec.conversion Description:: + -- @@ -127,7 +129,7 @@ Required:: | WebhookConversion describes how to call a conversion webhook |=== -..spec.conversion.webhook +=== .spec.conversion.webhook Description:: + -- @@ -155,7 +157,7 @@ Required:: | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. |=== -..spec.conversion.webhook.clientConfig +=== .spec.conversion.webhook.clientConfig Description:: + -- @@ -195,7 +197,7 @@ A path is optional, and if present may be any string permissible in a URL. You m Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |=== -..spec.conversion.webhook.clientConfig.service +=== .spec.conversion.webhook.clientConfig.service Description:: + -- @@ -232,7 +234,7 @@ Required:: | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility. |=== -..spec.names +=== .spec.names Description:: + -- @@ -277,7 +279,7 @@ Required:: | singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. |=== -..spec.versions +=== .spec.versions Description:: + -- @@ -290,7 +292,7 @@ Type:: -..spec.versions[] +=== .spec.versions[] Description:: + -- @@ -348,7 +350,7 @@ Required:: | CustomResourceSubresources defines the status and scale subresources for CustomResources. |=== -..spec.versions[].additionalPrinterColumns +=== .spec.versions[].additionalPrinterColumns Description:: + -- @@ -361,7 +363,7 @@ Type:: -..spec.versions[].additionalPrinterColumns[] +=== .spec.versions[].additionalPrinterColumns[] Description:: + -- @@ -407,7 +409,7 @@ Required:: | type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. |=== -..spec.versions[].schema +=== .spec.versions[].schema Description:: + -- @@ -425,11 +427,11 @@ Type:: | Property | Type | Description | `openAPIV3Schema` -| `` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[``] | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. |=== -..spec.versions[].subresources +=== .spec.versions[].subresources Description:: + -- @@ -455,7 +457,7 @@ Type:: | CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza |=== -..spec.versions[].subresources.scale +=== .spec.versions[].subresources.scale Description:: + -- @@ -488,7 +490,7 @@ Required:: | statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. |=== -..spec.versions[].subresources.status +=== .spec.versions[].subresources.status Description:: + -- @@ -501,7 +503,7 @@ Type:: -..status +=== .status Description:: + -- @@ -535,7 +537,7 @@ Type:: | storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list. |=== -..status.acceptedNames +=== .status.acceptedNames Description:: + -- @@ -580,7 +582,7 @@ Required:: | singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -593,7 +595,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -614,7 +616,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | lastTransitionTime last time the condition transitioned from one status to another. | `message` @@ -643,11 +645,15 @@ The following API endpoints are available: - `DELETE`: delete collection of CustomResourceDefinition - `GET`: list or watch objects of kind CustomResourceDefinition - `POST`: create a CustomResourceDefinition +* `/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions` +- `GET`: watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}` - `DELETE`: delete a CustomResourceDefinition - `GET`: read the specified CustomResourceDefinition - `PATCH`: partially update the specified CustomResourceDefinition - `PUT`: replace the specified CustomResourceDefinition +* `/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}` +- `GET`: watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status` - `GET`: read status of the specified CustomResourceDefinition - `PATCH`: partially update status of the specified CustomResourceDefinition @@ -725,7 +731,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -734,7 +740,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -791,7 +799,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#customresourcedefinitionlist-apiextensions-k8s-io-v1[`CustomResourceDefinitionList apiextensions.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList[`CustomResourceDefinitionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -818,7 +828,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema | |=== @@ -827,7 +837,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 201 - Created +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 202 - Accepted +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -881,7 +962,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -890,7 +971,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -905,7 +990,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -935,7 +1022,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -944,7 +1031,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 201 - Created +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -971,7 +1062,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema | |=== @@ -980,7 +1071,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 201 - Created +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CustomResourceDefinition +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -1016,7 +1184,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1046,7 +1216,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1055,7 +1225,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 201 - Created +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1082,7 +1256,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema | |=== @@ -1091,7 +1265,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition apiextensions.k8s.io/v1`] +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 201 - Created +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`CustomResourceDefinition`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/extension_apis/extension-apis-index.adoc b/rest_api/extension_apis/extension-apis-index.adoc index 9a98f50cdb9a..27260df92fef 100644 --- a/rest_api/extension_apis/extension-apis-index.adoc +++ b/rest_api/extension_apis/extension-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="extension-apis"] = Extension APIs ifdef::product-title[] diff --git a/rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc b/rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc index 9df00c4b22a5..1e4b8d4bf790 100644 --- a/rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc +++ b/rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="mutatingwebhookconfiguration-admissionregistration-k8s-io-v1"] = MutatingWebhookConfiguration [admissionregistration.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | `webhooks` @@ -45,7 +47,7 @@ Type:: | MutatingWebhook describes an admission webhook and the resources and operations it applies to. |=== -..webhooks +=== .webhooks Description:: + -- @@ -58,7 +60,7 @@ Type:: -..webhooks[] +=== .webhooks[] Description:: + -- @@ -107,7 +109,7 @@ Defaults to "Equivalent" | The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. | `namespaceSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { @@ -141,7 +143,7 @@ See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ fo Default to the empty LabelSelector, which matches everything. | `objectSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. | `reinvocationPolicy` @@ -171,7 +173,7 @@ Defaults to "Never". | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. |=== -..webhooks[].clientConfig +=== .webhooks[].clientConfig Description:: + -- @@ -211,7 +213,7 @@ A path is optional, and if present may be any string permissible in a URL. You m Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |=== -..webhooks[].clientConfig.service +=== .webhooks[].clientConfig.service Description:: + -- @@ -248,7 +250,7 @@ Required:: | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |=== -..webhooks[].rules +=== .webhooks[].rules Description:: + -- @@ -261,7 +263,7 @@ Type:: -..webhooks[].rules[] +=== .webhooks[].rules[] Description:: + -- @@ -314,11 +316,15 @@ The following API endpoints are available: - `DELETE`: delete collection of MutatingWebhookConfiguration - `GET`: list or watch objects of kind MutatingWebhookConfiguration - `POST`: create a MutatingWebhookConfiguration +* `/apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations` +- `GET`: watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}` - `DELETE`: delete a MutatingWebhookConfiguration - `GET`: read the specified MutatingWebhookConfiguration - `PATCH`: partially update the specified MutatingWebhookConfiguration - `PUT`: replace the specified MutatingWebhookConfiguration +* `/apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations/{name}` +- `GET`: watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations @@ -392,7 +398,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -401,7 +407,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -458,7 +466,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#mutatingwebhookconfigurationlist-admissionregistration-k8s-io-v1[`MutatingWebhookConfigurationList admissionregistration.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList[`MutatingWebhookConfigurationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -485,7 +495,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema | |=== @@ -494,7 +504,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 202 - Accepted +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -548,7 +629,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -557,7 +638,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +657,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -602,7 +689,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -611,7 +698,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -638,7 +729,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema | |=== @@ -647,7 +738,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`MutatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the MutatingWebhookConfiguration +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc b/rest_api/extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc index b94e1e2f725a..c57007f745bc 100644 --- a/rest_api/extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc +++ b/rest_api/extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="validatingwebhookconfiguration-admissionregistration-k8s-io-v1"] = ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | `webhooks` @@ -45,7 +47,7 @@ Type:: | ValidatingWebhook describes an admission webhook and the resources and operations it applies to. |=== -..webhooks +=== .webhooks Description:: + -- @@ -58,7 +60,7 @@ Type:: -..webhooks[] +=== .webhooks[] Description:: + -- @@ -107,7 +109,7 @@ Defaults to "Equivalent" | The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. | `namespaceSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { @@ -141,7 +143,7 @@ See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for Default to the empty LabelSelector, which matches everything. | `objectSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. | `rules` @@ -161,7 +163,7 @@ Default to the empty LabelSelector, which matches everything. | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. |=== -..webhooks[].clientConfig +=== .webhooks[].clientConfig Description:: + -- @@ -201,7 +203,7 @@ A path is optional, and if present may be any string permissible in a URL. You m Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |=== -..webhooks[].clientConfig.service +=== .webhooks[].clientConfig.service Description:: + -- @@ -238,7 +240,7 @@ Required:: | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |=== -..webhooks[].rules +=== .webhooks[].rules Description:: + -- @@ -251,7 +253,7 @@ Type:: -..webhooks[].rules[] +=== .webhooks[].rules[] Description:: + -- @@ -304,11 +306,15 @@ The following API endpoints are available: - `DELETE`: delete collection of ValidatingWebhookConfiguration - `GET`: list or watch objects of kind ValidatingWebhookConfiguration - `POST`: create a ValidatingWebhookConfiguration +* `/apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations` +- `GET`: watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}` - `DELETE`: delete a ValidatingWebhookConfiguration - `GET`: read the specified ValidatingWebhookConfiguration - `PATCH`: partially update the specified ValidatingWebhookConfiguration - `PUT`: replace the specified ValidatingWebhookConfiguration +* `/apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations/{name}` +- `GET`: watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations @@ -382,7 +388,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -391,7 +397,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -448,7 +456,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#validatingwebhookconfigurationlist-admissionregistration-k8s-io-v1[`ValidatingWebhookConfigurationList admissionregistration.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList[`ValidatingWebhookConfigurationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -475,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema | |=== @@ -484,7 +494,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 202 - Accepted +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -538,7 +619,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -547,7 +628,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -562,7 +647,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -592,7 +679,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -601,7 +688,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -628,7 +719,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema | |=== @@ -637,7 +728,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration admissionregistration.k8s.io/v1`] +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 201 - Created +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`ValidatingWebhookConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ValidatingWebhookConfiguration +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/image-apis-index.adoc b/rest_api/image_apis/image-apis-index.adoc index c6e238ca9116..0c2d7dea20b6 100644 --- a/rest_api/image_apis/image-apis-index.adoc +++ b/rest_api/image_apis/image-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="image-apis"] = Image APIs ifdef::product-title[] @@ -49,6 +51,17 @@ The image stream import resource provides an easy way for a user to find and imp This API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams. -- +Type:: + `object` + +== ImageStreamLayers [image.openshift.io/v1] + +Description:: ++ +-- +ImageStreamLayers describes information about the layers referenced by images in this image stream. +-- + Type:: `object` @@ -96,3 +109,14 @@ ImageTag represents a single tag within an image stream and includes the spec, t Type:: `object` +== SecretList [image.openshift.io/v1] + +Description:: ++ +-- +SecretList is a list of Secret. +-- + +Type:: + `object` + diff --git a/rest_api/image_apis/image-image-openshift-io-v1.adoc b/rest_api/image_apis/image-image-openshift-io-v1.adoc index 4a286e649a6a..b03949c38483 100644 --- a/rest_api/image_apis/image-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/image-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="image-image-openshift-io-v1"] = Image [image.openshift.io/v1] ifdef::product-title[] @@ -51,7 +53,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -71,7 +73,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -83,7 +85,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..dockerImageLayers +=== .dockerImageLayers Description:: + -- @@ -96,7 +98,7 @@ Type:: -..dockerImageLayers[] +=== .dockerImageLayers[] Description:: + -- @@ -130,7 +132,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..signatures +=== .signatures Description:: + -- @@ -143,7 +145,7 @@ Type:: -..signatures[] +=== .signatures[] Description:: + -- @@ -180,7 +182,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -200,7 +202,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -212,7 +214,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..signatures[].conditions +=== .signatures[].conditions Description:: + -- @@ -225,7 +227,7 @@ Type:: -..signatures[].conditions[] +=== .signatures[].conditions[] Description:: + -- @@ -246,11 +248,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -270,7 +272,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..signatures[].issuedBy +=== .signatures[].issuedBy Description:: + -- @@ -296,7 +298,7 @@ Type:: | Organization name. |=== -..signatures[].issuedTo +=== .signatures[].issuedTo Description:: + -- @@ -337,11 +339,15 @@ The following API endpoints are available: - `DELETE`: delete collection of Image - `GET`: list or watch objects of kind Image - `POST`: create an Image +* `/apis/image.openshift.io/v1/watch/images` +- `GET`: watch individual changes to a list of Image. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/image.openshift.io/v1/images/{name}` - `DELETE`: delete an Image - `GET`: read the specified Image - `PATCH`: partially update the specified Image - `PUT`: replace the specified Image +* `/apis/image.openshift.io/v1/watch/images/{name}` +- `GET`: watch changes to an object of kind Image. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/image.openshift.io/v1/images @@ -415,7 +421,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -424,7 +430,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -481,7 +489,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagelist-image-openshift-io-v1[`ImageList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageList[`ImageList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -508,7 +518,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema | |=== @@ -517,7 +527,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 201 - Created +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 202 - Accepted +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/image.openshift.io/v1/watch/images + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Image. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -571,7 +652,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -580,7 +661,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -595,7 +680,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -625,7 +712,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -634,7 +721,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -661,7 +750,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema | |=== @@ -670,7 +759,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image image.openshift.io/v1`] +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 201 - Created +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`Image`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/image.openshift.io/v1/watch/images/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Image +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Image. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagesignature-image-openshift-io-v1.adoc b/rest_api/image_apis/imagesignature-image-openshift-io-v1.adoc index 4a61410c347f..34c4e27553e0 100644 --- a/rest_api/image_apis/imagesignature-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagesignature-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagesignature-image-openshift-io-v1"] = ImageSignature [image.openshift.io/v1] ifdef::product-title[] @@ -44,7 +46,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -64,7 +66,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -76,7 +78,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..conditions +=== .conditions Description:: + -- @@ -89,7 +91,7 @@ Type:: -..conditions[] +=== .conditions[] Description:: + -- @@ -110,11 +112,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -134,7 +136,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..issuedBy +=== .issuedBy Description:: + -- @@ -160,7 +162,7 @@ Type:: | Organization name. |=== -..issuedTo +=== .issuedTo Description:: + -- @@ -234,7 +236,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature image.openshift.io/v1`] +| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema | |=== @@ -243,7 +245,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature image.openshift.io/v1`] +| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema +| 201 - Created +| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema +| 202 - Accepted +| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema +| 401 - Unauthorized +| Empty |=== @@ -292,7 +300,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -301,7 +309,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagestream-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestream-image-openshift-io-v1.adoc index 8d05e6ff4b61..63186bdf8926 100644 --- a/rest_api/image_apis/imagestream-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestream-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagestream-image-openshift-io-v1"] = ImageStream [image.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -45,7 +47,7 @@ Type:: | ImageStreamStatus contains information about the state of this image stream. |=== -..spec +=== .spec Description:: + -- @@ -79,7 +81,7 @@ Type:: | TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. |=== -..spec.lookupPolicy +=== .spec.lookupPolicy Description:: + -- @@ -103,7 +105,7 @@ Required:: | local will change the docker short image references (like "mysql" or "php:latest") on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag's referencePolicy is taken into account on the replaced value. Only works within the current namespace. |=== -..spec.tags +=== .spec.tags Description:: + -- @@ -116,7 +118,7 @@ Type:: -..spec.tags[] +=== .spec.tags[] Description:: + -- @@ -140,7 +142,7 @@ Required:: | Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream. | `generation` @@ -164,7 +166,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. |=== -..spec.tags[].importPolicy +=== .spec.tags[].importPolicy Description:: + -- @@ -190,7 +192,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..spec.tags[].referencePolicy +=== .spec.tags[].referencePolicy Description:: + -- @@ -214,7 +216,7 @@ Required:: | Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable. |=== -..status +=== .status Description:: + -- @@ -250,7 +252,7 @@ Required:: | NamedTagEventList relates a tag to its image history. |=== -..status.tags +=== .status.tags Description:: + -- @@ -263,7 +265,7 @@ Type:: -..status.tags[] +=== .status.tags[] Description:: + -- @@ -304,7 +306,7 @@ Required:: | Tag is the tag for which the history is recorded |=== -..status.tags[].conditions +=== .status.tags[].conditions Description:: + -- @@ -317,7 +319,7 @@ Type:: -..status.tags[].conditions[] +=== .status.tags[].conditions[] Description:: + -- @@ -343,7 +345,7 @@ Required:: | Generation is the spec tag generation that this status corresponds to | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | LastTransitionTIme is the time the condition transitioned from one status to another. | `message` @@ -363,7 +365,7 @@ Required:: | Type of tag event condition, currently only ImportSuccess |=== -..status.tags[].items +=== .status.tags[].items Description:: + -- @@ -376,7 +378,7 @@ Type:: -..status.tags[].items[] +=== .status.tags[].items[] Description:: + -- @@ -399,7 +401,7 @@ Required:: | Property | Type | Description | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Created holds the time the TagEvent was created | `dockerImageReference` @@ -422,23 +424,25 @@ The following API endpoints are available: * `/apis/image.openshift.io/v1/imagestreams` - `GET`: list or watch objects of kind ImageStream +* `/apis/image.openshift.io/v1/watch/imagestreams` +- `GET`: watch individual changes to a list of ImageStream. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams` - `DELETE`: delete collection of ImageStream - `GET`: list or watch objects of kind ImageStream - `POST`: create an ImageStream +* `/apis/image.openshift.io/v1/watch/namespaces/{namespace}/imagestreams` +- `GET`: watch individual changes to a list of ImageStream. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}` - `DELETE`: delete an ImageStream - `GET`: read the specified ImageStream - `PATCH`: partially update the specified ImageStream - `PUT`: replace the specified ImageStream -* `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers` -- `GET`: read layers of the specified ImageStream +* `/apis/image.openshift.io/v1/watch/namespaces/{namespace}/imagestreams/{name}` +- `GET`: watch changes to an object of kind ImageStream. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/status` - `GET`: read status of the specified ImageStream - `PATCH`: partially update status of the specified ImageStream - `PUT`: replace status of the specified ImageStream -* `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/secrets` -- `GET`: read secrets of the specified ImageStream === /apis/image.openshift.io/v1/imagestreams @@ -500,7 +504,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagestreamlist-image-openshift-io-v1[`ImageStreamList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageStreamList[`ImageStreamList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/image.openshift.io/v1/watch/imagestreams + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ImageStream. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -583,7 +654,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -592,7 +663,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -649,7 +722,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagestreamlist-image-openshift-io-v1[`ImageStreamList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageStreamList[`ImageStreamList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -676,7 +751,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema | |=== @@ -685,7 +760,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 201 - Created +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 202 - Accepted +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/image.openshift.io/v1/watch/namespaces/{namespace}/imagestreams + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ImageStream. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -742,7 +896,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -751,7 +905,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -766,7 +924,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -796,7 +956,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -805,7 +965,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -832,7 +994,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema | |=== @@ -841,11 +1003,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 201 - Created +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers +=== /apis/image.openshift.io/v1/watch/namespaces/{namespace}/imagestreams/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -853,7 +1019,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the ImageStreamLayers +| name of the ImageStream | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -863,16 +1029,51 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: - read layers of the specified ImageStream + watch changes to an object of kind ImageStream. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. .HTTP responses @@ -880,7 +1081,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagestreamlayers-image-openshift-io-v1[`ImageStreamLayers image.openshift.io/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -919,7 +1122,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -949,7 +1154,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -958,7 +1163,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -985,7 +1192,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema | |=== @@ -994,81 +1201,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream image.openshift.io/v1`] -|=== - - -=== /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/secrets - -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` -| `string` -| name of the SecretList -| `namespace` -| `string` -| object name and auth scope, such as for teams and projects -|=== - -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `allowWatchBookmarks` -| `boolean` -| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. -| `continue` -| `string` -| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". - -This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. -| `fieldSelector` -| `string` -| A selector to restrict the list of returned objects by their fields. Defaults to everything. -| `labelSelector` -| `string` -| A selector to restrict the list of returned objects by their labels. Defaults to everything. -| `limit` -| `integer` -| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - -The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. -| `pretty` -| `string` -| If 'true', then the output is pretty printed. -| `resourceVersion` -| `string` -| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. - -Defaults to unset -| `resourceVersionMatch` -| `string` -| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. - -Defaults to unset -| `timeoutSeconds` -| `integer` -| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. -| `watch` -| `boolean` -| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. -|=== - -HTTP method:: - `GET` - -Description:: - read secrets of the specified ImageStream - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#secretlist-image-openshift-io-v1[`SecretList image.openshift.io/v1`] +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 201 - Created +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`ImageStream`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagestreamimage-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreamimage-image-openshift-io-v1.adoc index c3548d17962d..8fc25c8cf5a2 100644 --- a/rest_api/image_apis/imagestreamimage-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestreamimage-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagestreamimage-image-openshift-io-v1"] = ImageStreamImage [image.openshift.io/v1] ifdef::product-title[] @@ -39,11 +41,11 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | |=== -..image +=== .image Description:: + -- @@ -87,7 +89,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -107,7 +109,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -119,7 +121,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..image.dockerImageLayers +=== .image.dockerImageLayers Description:: + -- @@ -132,7 +134,7 @@ Type:: -..image.dockerImageLayers[] +=== .image.dockerImageLayers[] Description:: + -- @@ -166,7 +168,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..image.signatures +=== .image.signatures Description:: + -- @@ -179,7 +181,7 @@ Type:: -..image.signatures[] +=== .image.signatures[] Description:: + -- @@ -216,7 +218,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -236,7 +238,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -248,7 +250,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..image.signatures[].conditions +=== .image.signatures[].conditions Description:: + -- @@ -261,7 +263,7 @@ Type:: -..image.signatures[].conditions[] +=== .image.signatures[].conditions[] Description:: + -- @@ -282,11 +284,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -306,7 +308,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..image.signatures[].issuedBy +=== .image.signatures[].issuedBy Description:: + -- @@ -332,7 +334,7 @@ Type:: | Organization name. |=== -..image.signatures[].issuedTo +=== .image.signatures[].issuedTo Description:: + -- @@ -408,7 +410,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamimage-image-openshift-io-v1.adoc#imagestreamimage-image-openshift-io-v1[`ImageStreamImage image.openshift.io/v1`] +| xref:../image_apis/imagestreamimage-image-openshift-io-v1.adoc#imagestreamimage-image-openshift-io-v1[`ImageStreamImage`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc index 4391ed385498..a317ba682857 100644 --- a/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagestreamimport-image-openshift-io-v1"] = ImageStreamImport [image.openshift.io/v1] ifdef::product-title[] @@ -38,7 +40,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -50,7 +52,7 @@ Required:: | ImageStreamImportStatus contains information about the status of an image stream import. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Required:: | RepositoryImportSpec describes a request to import images from a container image repository. |=== -..spec.images +=== .spec.images Description:: + -- @@ -99,7 +101,7 @@ Type:: -..spec.images[] +=== .spec.images[] Description:: + -- @@ -119,7 +121,7 @@ Required:: | Property | Type | Description | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | From is the source of an image to import; only kind DockerImage is allowed | `importPolicy` @@ -135,11 +137,11 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. | `to` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | To is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used |=== -..spec.images[].importPolicy +=== .spec.images[].importPolicy Description:: + -- @@ -165,7 +167,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..spec.images[].referencePolicy +=== .spec.images[].referencePolicy Description:: + -- @@ -189,7 +191,7 @@ Required:: | Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable. |=== -..spec.repository +=== .spec.repository Description:: + -- @@ -209,7 +211,7 @@ Required:: | Property | Type | Description | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | From is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed | `importPolicy` @@ -225,7 +227,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. |=== -..spec.repository.importPolicy +=== .spec.repository.importPolicy Description:: + -- @@ -251,7 +253,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..spec.repository.referencePolicy +=== .spec.repository.referencePolicy Description:: + -- @@ -275,7 +277,7 @@ Required:: | Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable. |=== -..status +=== .status Description:: + -- @@ -309,7 +311,7 @@ Type:: | RepositoryImportStatus describes the result of an image repository import |=== -..status.images +=== .status.images Description:: + -- @@ -322,7 +324,7 @@ Type:: -..status.images[] +=== .status.images[] Description:: + -- @@ -346,7 +348,7 @@ Required:: | Image is an immutable representation of a container image and metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users instead access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents. | `status` -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] | Status is the status of the image import, including errors encountered while retrieving the image | `tag` @@ -354,7 +356,7 @@ Required:: | Tag is the tag this image was located under, if any |=== -..status.images[].image +=== .status.images[].image Description:: + -- @@ -398,7 +400,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -418,7 +420,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -430,7 +432,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..status.images[].image.dockerImageLayers +=== .status.images[].image.dockerImageLayers Description:: + -- @@ -443,7 +445,7 @@ Type:: -..status.images[].image.dockerImageLayers[] +=== .status.images[].image.dockerImageLayers[] Description:: + -- @@ -477,7 +479,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..status.images[].image.signatures +=== .status.images[].image.signatures Description:: + -- @@ -490,7 +492,7 @@ Type:: -..status.images[].image.signatures[] +=== .status.images[].image.signatures[] Description:: + -- @@ -527,7 +529,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -547,7 +549,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -559,7 +561,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..status.images[].image.signatures[].conditions +=== .status.images[].image.signatures[].conditions Description:: + -- @@ -572,7 +574,7 @@ Type:: -..status.images[].image.signatures[].conditions[] +=== .status.images[].image.signatures[].conditions[] Description:: + -- @@ -593,11 +595,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -617,7 +619,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..status.images[].image.signatures[].issuedBy +=== .status.images[].image.signatures[].issuedBy Description:: + -- @@ -643,7 +645,7 @@ Type:: | Organization name. |=== -..status.images[].image.signatures[].issuedTo +=== .status.images[].image.signatures[].issuedTo Description:: + -- @@ -675,7 +677,7 @@ Required:: | If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key's fingerprint (e.g. 0x685ebe62bf278440). |=== -..status.import +=== .status.import Description:: + -- @@ -701,7 +703,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -713,7 +715,7 @@ Type:: | ImageStreamStatus contains information about the state of this image stream. |=== -..status.import.spec +=== .status.import.spec Description:: + -- @@ -747,7 +749,7 @@ Type:: | TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. |=== -..status.import.spec.lookupPolicy +=== .status.import.spec.lookupPolicy Description:: + -- @@ -771,7 +773,7 @@ Required:: | local will change the docker short image references (like "mysql" or "php:latest") on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag's referencePolicy is taken into account on the replaced value. Only works within the current namespace. |=== -..status.import.spec.tags +=== .status.import.spec.tags Description:: + -- @@ -784,7 +786,7 @@ Type:: -..status.import.spec.tags[] +=== .status.import.spec.tags[] Description:: + -- @@ -808,7 +810,7 @@ Required:: | Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream. | `generation` @@ -832,7 +834,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. |=== -..status.import.spec.tags[].importPolicy +=== .status.import.spec.tags[].importPolicy Description:: + -- @@ -858,7 +860,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..status.import.spec.tags[].referencePolicy +=== .status.import.spec.tags[].referencePolicy Description:: + -- @@ -882,7 +884,7 @@ Required:: | Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable. |=== -..status.import.status +=== .status.import.status Description:: + -- @@ -918,7 +920,7 @@ Required:: | NamedTagEventList relates a tag to its image history. |=== -..status.import.status.tags +=== .status.import.status.tags Description:: + -- @@ -931,7 +933,7 @@ Type:: -..status.import.status.tags[] +=== .status.import.status.tags[] Description:: + -- @@ -972,7 +974,7 @@ Required:: | Tag is the tag for which the history is recorded |=== -..status.import.status.tags[].conditions +=== .status.import.status.tags[].conditions Description:: + -- @@ -985,7 +987,7 @@ Type:: -..status.import.status.tags[].conditions[] +=== .status.import.status.tags[].conditions[] Description:: + -- @@ -1011,7 +1013,7 @@ Required:: | Generation is the spec tag generation that this status corresponds to | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | LastTransitionTIme is the time the condition transitioned from one status to another. | `message` @@ -1031,7 +1033,7 @@ Required:: | Type of tag event condition, currently only ImportSuccess |=== -..status.import.status.tags[].items +=== .status.import.status.tags[].items Description:: + -- @@ -1044,7 +1046,7 @@ Type:: -..status.import.status.tags[].items[] +=== .status.import.status.tags[].items[] Description:: + -- @@ -1067,7 +1069,7 @@ Required:: | Property | Type | Description | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Created holds the time the TagEvent was created | `dockerImageReference` @@ -1083,7 +1085,7 @@ Required:: | Image is the image |=== -..status.repository +=== .status.repository Description:: + -- @@ -1113,11 +1115,11 @@ Type:: | ImageImportStatus describes the result of an image import. | `status` -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] | Status reflects whether any failure occurred during import |=== -..status.repository.images +=== .status.repository.images Description:: + -- @@ -1130,7 +1132,7 @@ Type:: -..status.repository.images[] +=== .status.repository.images[] Description:: + -- @@ -1154,7 +1156,7 @@ Required:: | Image is an immutable representation of a container image and metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users instead access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents. | `status` -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] | Status is the status of the image import, including errors encountered while retrieving the image | `tag` @@ -1162,7 +1164,7 @@ Required:: | Tag is the tag this image was located under, if any |=== -..status.repository.images[].image +=== .status.repository.images[].image Description:: + -- @@ -1206,7 +1208,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -1226,7 +1228,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -1238,7 +1240,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..status.repository.images[].image.dockerImageLayers +=== .status.repository.images[].image.dockerImageLayers Description:: + -- @@ -1251,7 +1253,7 @@ Type:: -..status.repository.images[].image.dockerImageLayers[] +=== .status.repository.images[].image.dockerImageLayers[] Description:: + -- @@ -1285,7 +1287,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..status.repository.images[].image.signatures +=== .status.repository.images[].image.signatures Description:: + -- @@ -1298,7 +1300,7 @@ Type:: -..status.repository.images[].image.signatures[] +=== .status.repository.images[].image.signatures[] Description:: + -- @@ -1335,7 +1337,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -1355,7 +1357,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -1367,7 +1369,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..status.repository.images[].image.signatures[].conditions +=== .status.repository.images[].image.signatures[].conditions Description:: + -- @@ -1380,7 +1382,7 @@ Type:: -..status.repository.images[].image.signatures[].conditions[] +=== .status.repository.images[].image.signatures[].conditions[] Description:: + -- @@ -1401,11 +1403,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -1425,7 +1427,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..status.repository.images[].image.signatures[].issuedBy +=== .status.repository.images[].image.signatures[].issuedBy Description:: + -- @@ -1451,7 +1453,7 @@ Type:: | Organization name. |=== -..status.repository.images[].image.signatures[].issuedTo +=== .status.repository.images[].image.signatures[].issuedTo Description:: + -- @@ -1531,7 +1533,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport image.openshift.io/v1`] +| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema | |=== @@ -1540,7 +1542,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport image.openshift.io/v1`] +| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema +| 201 - Created +| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema +| 202 - Accepted +| xref:../image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[`ImageStreamImport`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagestreamlayers-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreamlayers-image-openshift-io-v1.adoc new file mode 100644 index 000000000000..b08af86c14df --- /dev/null +++ b/rest_api/image_apis/imagestreamlayers-image-openshift-io-v1.adoc @@ -0,0 +1,195 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="imagestreamlayers-image-openshift-io-v1"] += ImageStreamLayers [image.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ImageStreamLayers describes information about the layers referenced by images in this image stream. +-- + +Type:: + `object` + +Required:: + - `blobs` + - `images` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `blobs` +| `object` +| blobs is a map of blob name to metadata about the blob. + +| `blobs{}` +| `object` +| ImageLayerData contains metadata about an image layer. + +| `images` +| `object` +| images is a map between an image name and the names of the blobs and config that comprise the image. + +| `images{}` +| `object` +| ImageBlobReferences describes the blob references within an image. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| + +|=== +=== .blobs +Description:: ++ +-- +blobs is a map of blob name to metadata about the blob. +-- + +Type:: + `object` + + + + +=== .blobs{} +Description:: ++ +-- +ImageLayerData contains metadata about an image layer. +-- + +Type:: + `object` + +Required:: + - `size` + - `mediaType` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mediaType` +| `string` +| MediaType of the referenced object. + +| `size` +| `integer` +| Size of the layer in bytes as defined by the underlying store. This field is optional if the necessary information about size is not available. + +|=== +=== .images +Description:: ++ +-- +images is a map between an image name and the names of the blobs and config that comprise the image. +-- + +Type:: + `object` + + + + +=== .images{} +Description:: ++ +-- +ImageBlobReferences describes the blob references within an image. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `config` +| `string` +| config, if set, is the blob that contains the image config. Some images do not have separate config blobs and this field will be set to nil if so. + +| `imageMissing` +| `boolean` +| imageMissing is true if the image is referenced by the image stream but the image object has been deleted from the API by an administrator. When this field is set, layers and config fields may be empty and callers that depend on the image metadata should consider the image to be unavailable for download or viewing. + +| `layers` +| `array (string)` +| layers is the list of blobs that compose this image, from base layer to top layer. All layers referenced by this array will be defined in the blobs map. Some images may have zero layers. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers` +- `GET`: read layers of the specified ImageStream + + +=== /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/layers + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ImageStreamLayers +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read layers of the specified ImageStream + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../image_apis/imagestreamlayers-image-openshift-io-v1.adoc#imagestreamlayers-image-openshift-io-v1[`ImageStreamLayers`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/image_apis/imagestreammapping-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreammapping-image-openshift-io-v1.adoc index 3815bd4e58b5..67c78f14fb2b 100644 --- a/rest_api/image_apis/imagestreammapping-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestreammapping-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagestreammapping-image-openshift-io-v1"] = ImageStreamMapping [image.openshift.io/v1] ifdef::product-title[] @@ -40,7 +42,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `tag` @@ -48,7 +50,7 @@ Required:: | Tag is a string value this image can be located with inside the stream. |=== -..image +=== .image Description:: + -- @@ -92,7 +94,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -112,7 +114,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -124,7 +126,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..image.dockerImageLayers +=== .image.dockerImageLayers Description:: + -- @@ -137,7 +139,7 @@ Type:: -..image.dockerImageLayers[] +=== .image.dockerImageLayers[] Description:: + -- @@ -171,7 +173,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..image.signatures +=== .image.signatures Description:: + -- @@ -184,7 +186,7 @@ Type:: -..image.signatures[] +=== .image.signatures[] Description:: + -- @@ -221,7 +223,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -241,7 +243,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -253,7 +255,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..image.signatures[].conditions +=== .image.signatures[].conditions Description:: + -- @@ -266,7 +268,7 @@ Type:: -..image.signatures[].conditions[] +=== .image.signatures[].conditions[] Description:: + -- @@ -287,11 +289,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -311,7 +313,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..image.signatures[].issuedBy +=== .image.signatures[].issuedBy Description:: + -- @@ -337,7 +339,7 @@ Type:: | Organization name. |=== -..image.signatures[].issuedTo +=== .image.signatures[].issuedTo Description:: + -- @@ -417,7 +419,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping image.openshift.io/v1`] +| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping`] schema | |=== @@ -426,7 +428,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping image.openshift.io/v1`] +| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping`] schema +| 201 - Created +| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping`] schema +| 202 - Accepted +| xref:../image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[`ImageStreamMapping`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagestreamtag-image-openshift-io-v1.adoc b/rest_api/image_apis/imagestreamtag-image-openshift-io-v1.adoc index 37cfec793417..71e7993c1e79 100644 --- a/rest_api/image_apis/imagestreamtag-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagestreamtag-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagestreamtag-image-openshift-io-v1"] = ImageStreamTag [image.openshift.io/v1] ifdef::product-title[] @@ -58,7 +60,7 @@ Required:: | ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace. | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `tag` @@ -66,7 +68,7 @@ Required:: | TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track. |=== -..conditions +=== .conditions Description:: + -- @@ -79,7 +81,7 @@ Type:: -..conditions[] +=== .conditions[] Description:: + -- @@ -105,7 +107,7 @@ Required:: | Generation is the spec tag generation that this status corresponds to | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | LastTransitionTIme is the time the condition transitioned from one status to another. | `message` @@ -125,7 +127,7 @@ Required:: | Type of tag event condition, currently only ImportSuccess |=== -..image +=== .image Description:: + -- @@ -169,7 +171,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -189,7 +191,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -201,7 +203,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..image.dockerImageLayers +=== .image.dockerImageLayers Description:: + -- @@ -214,7 +216,7 @@ Type:: -..image.dockerImageLayers[] +=== .image.dockerImageLayers[] Description:: + -- @@ -248,7 +250,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..image.signatures +=== .image.signatures Description:: + -- @@ -261,7 +263,7 @@ Type:: -..image.signatures[] +=== .image.signatures[] Description:: + -- @@ -298,7 +300,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -318,7 +320,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -330,7 +332,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..image.signatures[].conditions +=== .image.signatures[].conditions Description:: + -- @@ -343,7 +345,7 @@ Type:: -..image.signatures[].conditions[] +=== .image.signatures[].conditions[] Description:: + -- @@ -364,11 +366,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -388,7 +390,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..image.signatures[].issuedBy +=== .image.signatures[].issuedBy Description:: + -- @@ -414,7 +416,7 @@ Type:: | Organization name. |=== -..image.signatures[].issuedTo +=== .image.signatures[].issuedTo Description:: + -- @@ -446,7 +448,7 @@ Required:: | If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key's fingerprint (e.g. 0x685ebe62bf278440). |=== -..lookupPolicy +=== .lookupPolicy Description:: + -- @@ -470,7 +472,7 @@ Required:: | local will change the docker short image references (like "mysql" or "php:latest") on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag's referencePolicy is taken into account on the replaced value. Only works within the current namespace. |=== -..tag +=== .tag Description:: + -- @@ -494,7 +496,7 @@ Required:: | Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream. | `generation` @@ -518,7 +520,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. |=== -..tag.importPolicy +=== .tag.importPolicy Description:: + -- @@ -544,7 +546,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..tag.referencePolicy +=== .tag.referencePolicy Description:: + -- @@ -644,7 +646,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagestreamtaglist-image-openshift-io-v1[`ImageStreamTagList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageStreamTagList[`ImageStreamTagList`] schema +| 401 - Unauthorized +| Empty |=== @@ -722,7 +726,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagestreamtaglist-image-openshift-io-v1[`ImageStreamTagList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageStreamTagList[`ImageStreamTagList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -749,7 +755,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema | |=== @@ -758,7 +764,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 201 - Created +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 202 - Accepted +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 401 - Unauthorized +| Empty |=== @@ -815,7 +827,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -824,7 +836,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -839,7 +855,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -869,7 +887,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -878,7 +896,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -905,7 +925,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema | |=== @@ -914,7 +934,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag image.openshift.io/v1`] +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 201 - Created +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`ImageStreamTag`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/imagetag-image-openshift-io-v1.adoc b/rest_api/image_apis/imagetag-image-openshift-io-v1.adoc index e4c0fda1ed43..407da4bbe81c 100644 --- a/rest_api/image_apis/imagetag-image-openshift-io-v1.adoc +++ b/rest_api/image_apis/imagetag-image-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagetag-image-openshift-io-v1"] = ImageTag [image.openshift.io/v1] ifdef::product-title[] @@ -41,7 +43,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -53,7 +55,7 @@ Required:: | NamedTagEventList relates a tag to its image history. |=== -..image +=== .image Description:: + -- @@ -97,7 +99,7 @@ Required:: | DockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2. | `dockerImageMetadata` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | DockerImageMetadata contains metadata about this image | `dockerImageMetadataVersion` @@ -117,7 +119,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signatures` @@ -129,7 +131,7 @@ Required:: | ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose. |=== -..image.dockerImageLayers +=== .image.dockerImageLayers Description:: + -- @@ -142,7 +144,7 @@ Type:: -..image.dockerImageLayers[] +=== .image.dockerImageLayers[] Description:: + -- @@ -176,7 +178,7 @@ Required:: | Size of the layer in bytes as defined by the underlying store. |=== -..image.signatures +=== .image.signatures Description:: + -- @@ -189,7 +191,7 @@ Type:: -..image.signatures[] +=== .image.signatures[] Description:: + -- @@ -226,7 +228,7 @@ Required:: | Required: An opaque binary string which is an image's signature. | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | If specified, it is the time of signature's creation. | `imageIdentity` @@ -246,7 +248,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `signedClaims` @@ -258,7 +260,7 @@ Required:: | Required: Describes a type of stored blob. |=== -..image.signatures[].conditions +=== .image.signatures[].conditions Description:: + -- @@ -271,7 +273,7 @@ Type:: -..image.signatures[].conditions[] +=== .image.signatures[].conditions[] Description:: + -- @@ -292,11 +294,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -316,7 +318,7 @@ Required:: | Type of signature condition, Complete or Failed. |=== -..image.signatures[].issuedBy +=== .image.signatures[].issuedBy Description:: + -- @@ -342,7 +344,7 @@ Type:: | Organization name. |=== -..image.signatures[].issuedTo +=== .image.signatures[].issuedTo Description:: + -- @@ -374,7 +376,7 @@ Required:: | If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key's fingerprint (e.g. 0x685ebe62bf278440). |=== -..spec +=== .spec Description:: + -- @@ -398,7 +400,7 @@ Required:: | Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream. | `generation` @@ -422,7 +424,7 @@ Required:: | TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed. |=== -..spec.importPolicy +=== .spec.importPolicy Description:: + -- @@ -448,7 +450,7 @@ Type:: | Scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported |=== -..spec.referencePolicy +=== .spec.referencePolicy Description:: + -- @@ -472,7 +474,7 @@ Required:: | Type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable. |=== -..status +=== .status Description:: + -- @@ -513,7 +515,7 @@ Required:: | Tag is the tag for which the history is recorded |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -526,7 +528,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -552,7 +554,7 @@ Required:: | Generation is the spec tag generation that this status corresponds to | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | LastTransitionTIme is the time the condition transitioned from one status to another. | `message` @@ -572,7 +574,7 @@ Required:: | Type of tag event condition, currently only ImportSuccess |=== -..status.items +=== .status.items Description:: + -- @@ -585,7 +587,7 @@ Type:: -..status.items[] +=== .status.items[] Description:: + -- @@ -608,7 +610,7 @@ Required:: | Property | Type | Description | `created` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Created holds the time the TagEvent was created | `dockerImageReference` @@ -700,7 +702,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagetaglist-image-openshift-io-v1[`ImageTagList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageTagList[`ImageTagList`] schema +| 401 - Unauthorized +| Empty |=== @@ -778,7 +782,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagetaglist-image-openshift-io-v1[`ImageTagList image.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.image.v1.ImageTagList[`ImageTagList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -805,7 +811,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema | |=== @@ -814,7 +820,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 201 - Created +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 202 - Accepted +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 401 - Unauthorized +| Empty |=== @@ -871,7 +883,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -880,7 +892,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -895,7 +911,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -925,7 +943,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -934,7 +952,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -961,7 +981,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema | |=== @@ -970,7 +990,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag image.openshift.io/v1`] +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 201 - Created +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`ImageTag`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/image_apis/secretlist-image-openshift-io-v1.adoc b/rest_api/image_apis/secretlist-image-openshift-io-v1.adoc new file mode 100644 index 000000000000..cf4bc7d2a2e5 --- /dev/null +++ b/rest_api/image_apis/secretlist-image-openshift-io-v1.adoc @@ -0,0 +1,132 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="secretlist-image-openshift-io-v1"] += SecretList [image.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +SecretList is a list of Secret. +-- + +Type:: + `object` + +Required:: + - `items` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../security_apis/secret-v1.adoc#secret-v1[`array (Secret)`] +| Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/secrets` +- `GET`: read secrets of the specified ImageStream + + +=== /apis/image.openshift.io/v1/namespaces/{namespace}/imagestreams/{name}/secrets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the SecretList +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + read secrets of the specified ImageStream + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../image_apis/secretlist-image-openshift-io-v1.adoc#secretlist-image-openshift-io-v1[`SecretList`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/index.adoc b/rest_api/index.adoc index d1de314d653d..335f7f520d11 100644 --- a/rest_api/index.adoc +++ b/rest_api/index.adoc @@ -1,4 +1,5 @@ // Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="api-index"] = API index ifdef::product-title[] @@ -26,8 +27,8 @@ endif::[] | operator.openshift.io/v1 | xref:./provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[BareMetalHost] | metal3.io/v1alpha1 -| xref:./metadata_apis/binding-core-v1.adoc#binding-core-v1[Binding] -| core/v1 +| xref:./metadata_apis/binding-v1.adoc#binding-v1[Binding] +| v1 | xref:./template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[BrokerTemplateInstance] | template.openshift.io/v1 | xref:./workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[Build] @@ -36,6 +37,10 @@ endif::[] | config.openshift.io/v1 | xref:./workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[BuildConfig] | build.openshift.io/v1 +| xref:./workloads_apis/buildlog-build-openshift-io-v1.adoc#buildlog-build-openshift-io-v1[BuildLog] +| build.openshift.io/v1 +| xref:./workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[BuildRequest] +| build.openshift.io/v1 | xref:./operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[CatalogSource] | operators.coreos.com/v1alpha1 | xref:./security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[CertificateSigningRequest] @@ -64,16 +69,16 @@ endif::[] | operators.coreos.com/v1alpha1 | xref:./config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[ClusterVersion] | config.openshift.io/v1 -| xref:./metadata_apis/componentstatus-core-v1.adoc#componentstatus-core-v1[ComponentStatus] -| core/v1 +| xref:./metadata_apis/componentstatus-v1.adoc#componentstatus-v1[ComponentStatus] +| v1 | xref:./operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[Config] | imageregistry.operator.openshift.io/v1 | xref:./operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[Config] | operator.openshift.io/v1 | xref:./operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[Config] | samples.operator.openshift.io/v1 -| xref:./metadata_apis/configmap-core-v1.adoc#configmap-core-v1[ConfigMap] -| core/v1 +| xref:./metadata_apis/configmap-v1.adoc#configmap-v1[ConfigMap] +| v1 | xref:./config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[Console] | config.openshift.io/v1 | xref:./operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[Console] @@ -118,6 +123,12 @@ endif::[] | apps/v1 | xref:./workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[DeploymentConfig] | apps.openshift.io/v1 +| xref:./workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc#deploymentconfigrollback-apps-openshift-io-v1[DeploymentConfigRollback] +| apps.openshift.io/v1 +| xref:./workloads_apis/deploymentlog-apps-openshift-io-v1.adoc#deploymentlog-apps-openshift-io-v1[DeploymentLog] +| apps.openshift.io/v1 +| xref:./workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc#deploymentrequest-apps-openshift-io-v1[DeploymentRequest] +| apps.openshift.io/v1 | xref:./config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[DNS] | config.openshift.io/v1 | xref:./operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[DNS] @@ -128,18 +139,22 @@ endif::[] | network.openshift.io/v1 | xref:./network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[EgressRouter] | network.operator.openshift.io/v1 -| xref:./network_apis/endpoints-core-v1.adoc#endpoints-core-v1[Endpoints] -| core/v1 +| xref:./network_apis/endpoints-v1.adoc#endpoints-v1[Endpoints] +| v1 | xref:./network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[EndpointSlice] | discovery.k8s.io/v1 | xref:./operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[Etcd] | operator.openshift.io/v1 -| xref:./metadata_apis/event-core-v1.adoc#event-core-v1[Event] -| core/v1 +| xref:./metadata_apis/event-v1.adoc#event-v1[Event] +| v1 | xref:./metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[Event] | events.k8s.io/v1 +| xref:./policy_apis/eviction-policy-v1.adoc#eviction-policy-v1[Eviction] +| policy/v1 | xref:./config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[FeatureGate] | config.openshift.io/v1 +| xref:./provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[FirmwareSchema] +| metal3.io/v1alpha1 | xref:./schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[FlowSchema] | flowcontrol.apiserver.k8s.io/v1beta1 | xref:./user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[Group] @@ -148,6 +163,8 @@ endif::[] | helm.openshift.io/v1beta1 | xref:./autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[HorizontalPodAutoscaler] | autoscaling/v1 +| xref:./provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[HostFirmwareSettings] +| metal3.io/v1alpha1 | xref:./network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[HostSubnet] | network.openshift.io/v1 | xref:./user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[Identity] @@ -156,6 +173,8 @@ endif::[] | config.openshift.io/v1 | xref:./image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[Image] | image.openshift.io/v1 +| xref:./config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[ImageContentPolicy] +| config.openshift.io/v1 | xref:./operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[ImageContentSourcePolicy] | operator.openshift.io/v1alpha1 | xref:./operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[ImagePruner] @@ -168,6 +187,8 @@ endif::[] | image.openshift.io/v1 | xref:./image_apis/imagestreamimport-image-openshift-io-v1.adoc#imagestreamimport-image-openshift-io-v1[ImageStreamImport] | image.openshift.io/v1 +| xref:./image_apis/imagestreamlayers-image-openshift-io-v1.adoc#imagestreamlayers-image-openshift-io-v1[ImageStreamLayers] +| image.openshift.io/v1 | xref:./image_apis/imagestreammapping-image-openshift-io-v1.adoc#imagestreammapping-image-openshift-io-v1[ImageStreamMapping] | image.openshift.io/v1 | xref:./image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[ImageStreamTag] @@ -202,8 +223,8 @@ endif::[] | operator.openshift.io/v1 | xref:./metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[Lease] | coordination.k8s.io/v1 -| xref:./schedule_and_quota_apis/limitrange-core-v1.adoc#limitrange-core-v1[LimitRange] -| core/v1 +| xref:./schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[LimitRange] +| v1 | xref:./authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc#localresourceaccessreview-authorization-openshift-io-v1[LocalResourceAccessReview] | authorization.openshift.io/v1 | xref:./authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc#localsubjectaccessreview-authorization-k8s-io-v1[LocalSubjectAccessReview] @@ -224,8 +245,8 @@ endif::[] | machine.openshift.io/v1beta1 | xref:./extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[MutatingWebhookConfiguration] | admissionregistration.k8s.io/v1 -| xref:./metadata_apis/namespace-core-v1.adoc#namespace-core-v1[Namespace] -| core/v1 +| xref:./metadata_apis/namespace-v1.adoc#namespace-v1[Namespace] +| v1 | xref:./network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[NetNamespace] | network.openshift.io/v1 | xref:./config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[Network] @@ -236,8 +257,8 @@ endif::[] | k8s.cni.cncf.io/v1 | xref:./network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[NetworkPolicy] | networking.k8s.io/v1 -| xref:./node_apis/node-core-v1.adoc#node-core-v1[Node] -| core/v1 +| xref:./node_apis/node-v1.adoc#node-v1[Node] +| v1 | xref:./config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[OAuth] | config.openshift.io/v1 | xref:./oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[OAuthAccessToken] @@ -264,12 +285,12 @@ endif::[] | network.operator.openshift.io/v1 | xref:./operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[PackageManifest] | packages.operators.coreos.com/v1 -| xref:./workloads_apis/persistentvolume-core-v1.adoc#persistentvolume-core-v1[PersistentVolume] -| core/v1 -| xref:./storage_apis/persistentvolumeclaim-core-v1.adoc#persistentvolumeclaim-core-v1[PersistentVolumeClaim] -| core/v1 -| xref:./workloads_apis/pod-core-v1.adoc#pod-core-v1[Pod] -| core/v1 +| xref:./workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[PersistentVolume] +| v1 +| xref:./storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[PersistentVolumeClaim] +| v1 +| xref:./workloads_apis/pod-v1.adoc#pod-v1[Pod] +| v1 | xref:./policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[PodDisruptionBudget] | policy/v1 | xref:./monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[PodMonitor] @@ -282,8 +303,8 @@ endif::[] | security.openshift.io/v1 | xref:./security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[PodSecurityPolicySubjectReview] | security.openshift.io/v1 -| xref:./template_apis/podtemplate-core-v1.adoc#podtemplate-core-v1[PodTemplate] -| core/v1 +| xref:./template_apis/podtemplate-v1.adoc#podtemplate-v1[PodTemplate] +| v1 | xref:./schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[PriorityClass] | scheduling.k8s.io/v1 | xref:./schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[PriorityLevelConfiguration] @@ -310,12 +331,12 @@ endif::[] | security.openshift.io/v1 | xref:./workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[ReplicaSet] | apps/v1 -| xref:./workloads_apis/replicationcontroller-core-v1.adoc#replicationcontroller-core-v1[ReplicationController] -| core/v1 +| xref:./workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[ReplicationController] +| v1 | xref:./authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc#resourceaccessreview-authorization-openshift-io-v1[ResourceAccessReview] | authorization.openshift.io/v1 -| xref:./schedule_and_quota_apis/resourcequota-core-v1.adoc#resourcequota-core-v1[ResourceQuota] -| core/v1 +| xref:./schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[ResourceQuota] +| v1 | xref:./role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[Role] | authorization.openshift.io/v1 | xref:./rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[Role] @@ -330,10 +351,14 @@ endif::[] | route.openshift.io/v1 | xref:./node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[RuntimeClass] | node.k8s.io/v1 +| xref:./autoscale_apis/scale-autoscaling-v1.adoc#scale-autoscaling-v1[Scale] +| autoscaling/v1 | xref:./config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[Scheduler] | config.openshift.io/v1 -| xref:./security_apis/secret-core-v1.adoc#secret-core-v1[Secret] -| core/v1 +| xref:./security_apis/secret-v1.adoc#secret-v1[Secret] +| v1 +| xref:./image_apis/secretlist-image-openshift-io-v1.adoc#secretlist-image-openshift-io-v1[SecretList] +| image.openshift.io/v1 | xref:./security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] | security.openshift.io/v1 | xref:./authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc#selfsubjectaccessreview-authorization-k8s-io-v1[SelfSubjectAccessReview] @@ -342,10 +367,10 @@ endif::[] | authorization.k8s.io/v1 | xref:./authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc#selfsubjectrulesreview-authorization-openshift-io-v1[SelfSubjectRulesReview] | authorization.openshift.io/v1 -| xref:./network_apis/service-core-v1.adoc#service-core-v1[Service] -| core/v1 -| xref:./security_apis/serviceaccount-core-v1.adoc#serviceaccount-core-v1[ServiceAccount] -| core/v1 +| xref:./network_apis/service-v1.adoc#service-v1[Service] +| v1 +| xref:./security_apis/serviceaccount-v1.adoc#serviceaccount-v1[ServiceAccount] +| v1 | xref:./operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[ServiceCA] | operator.openshift.io/v1 | xref:./monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor] @@ -374,6 +399,8 @@ endif::[] | template.openshift.io/v1 | xref:./monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[ThanosRuler] | monitoring.coreos.com/v1 +| xref:./authorization_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[TokenRequest] +| authentication.k8s.io/v1 | xref:./authorization_apis/tokenreview-authentication-k8s-io-v1.adoc#tokenreview-authentication-k8s-io-v1[TokenReview] | authentication.k8s.io/v1 | xref:./node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[Tuned] diff --git a/rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc b/rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc index 82c4c41a92e2..ede0c125ed17 100644 --- a/rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc +++ b/rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="containerruntimeconfig-machineconfiguration-openshift-io-v1"] = ContainerRuntimeConfig [machineconfiguration.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | ContainerRuntimeConfigStatus defines the observed state of a ContainerRuntimeConfig |=== -..spec +=== .spec Description:: + -- @@ -75,7 +77,7 @@ Required:: | A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. |=== -..spec.containerRuntimeConfig +=== .spec.containerRuntimeConfig Description:: + -- @@ -109,7 +111,7 @@ Type:: | pidsLimit specifies the maximum number of processes allowed in a container |=== -..spec.machineConfigPoolSelector +=== .spec.machineConfigPoolSelector Description:: + -- @@ -139,7 +141,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.machineConfigPoolSelector.matchExpressions +=== .spec.machineConfigPoolSelector.matchExpressions Description:: + -- @@ -152,7 +154,7 @@ Type:: -..spec.machineConfigPoolSelector.matchExpressions[] +=== .spec.machineConfigPoolSelector.matchExpressions[] Description:: + -- @@ -185,7 +187,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..status +=== .status Description:: + -- @@ -215,7 +217,7 @@ Type:: | observedGeneration represents the generation observed by the controller. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -228,7 +230,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -352,7 +354,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -409,7 +413,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#containerruntimeconfiglist-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfigList machineconfiguration.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.machineconfiguration.v1.ContainerRuntimeConfigList[`ContainerRuntimeConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -436,7 +442,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema | |=== @@ -445,7 +451,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 201 - Created +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 202 - Accepted +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -499,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -508,7 +520,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -535,7 +551,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -562,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -571,7 +589,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -598,7 +618,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema | |=== @@ -607,7 +627,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 201 - Created +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -655,7 +679,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -682,7 +708,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -691,7 +717,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -718,7 +746,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema | |=== @@ -727,7 +755,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 201 - Created +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`ContainerRuntimeConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc b/rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc index 03961e4ddd60..d497bf3d2309 100644 --- a/rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc +++ b/rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="controllerconfig-machineconfiguration-openshift-io-v1"] = ControllerConfig [machineconfiguration.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | ControllerConfigStatus is the status for ControllerConfig |=== -..spec +=== .spec Description:: + -- @@ -142,7 +144,7 @@ Required:: | rootCAData specifies the root CA data |=== -..spec.pullSecret +=== .spec.pullSecret Description:: + -- @@ -188,7 +190,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status +=== .status Description:: + -- @@ -218,7 +220,7 @@ Type:: | observedGeneration represents the generation observed by the controller. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -231,7 +233,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -358,7 +360,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -415,7 +419,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#controllerconfiglist-machineconfiguration-openshift-io-v1[`ControllerConfigList machineconfiguration.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.machineconfiguration.v1.ControllerConfigList[`ControllerConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -442,7 +448,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema | |=== @@ -451,7 +457,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 201 - Created +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 202 - Accepted +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -505,7 +517,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -514,7 +526,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -541,7 +557,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -568,7 +586,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -577,7 +595,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +624,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema | |=== @@ -613,7 +633,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 201 - Created +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -661,7 +685,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -688,7 +714,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -697,7 +723,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -724,7 +752,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema | |=== @@ -733,7 +761,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 201 - Created +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`ControllerConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc b/rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc index b3e125059035..b8a310f99bd0 100644 --- a/rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc +++ b/rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="kubeletconfig-machineconfiguration-openshift-io-v1"] = KubeletConfig [machineconfiguration.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | KubeletConfigStatus defines the observed state of a KubeletConfig |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: Note that the minimum TLS version for ingress controllers is 1.1, and the maximum TLS version is 1.2. An implication of this restriction is that the Modern TLS profile type cannot be used because it requires TLS 1.3. |=== -..spec.machineConfigPoolSelector +=== .spec.machineConfigPoolSelector Description:: + -- @@ -118,7 +120,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.machineConfigPoolSelector.matchExpressions +=== .spec.machineConfigPoolSelector.matchExpressions Description:: + -- @@ -131,7 +133,7 @@ Type:: -..spec.machineConfigPoolSelector.matchExpressions[] +=== .spec.machineConfigPoolSelector.matchExpressions[] Description:: + -- @@ -164,7 +166,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.tlsSecurityProfile +=== .spec.tlsSecurityProfile Description:: + -- @@ -219,7 +221,7 @@ Type:: Note that the Modern profile is currently not supported because it is not yet well adopted by common software libraries. |=== -..status +=== .status Description:: + -- @@ -249,7 +251,7 @@ Type:: | observedGeneration represents the generation observed by the controller. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -262,7 +264,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -386,7 +388,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -443,7 +447,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#kubeletconfiglist-machineconfiguration-openshift-io-v1[`KubeletConfigList machineconfiguration.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.machineconfiguration.v1.KubeletConfigList[`KubeletConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -470,7 +476,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema | |=== @@ -479,7 +485,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 201 - Created +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 202 - Accepted +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -533,7 +545,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -542,7 +554,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -569,7 +585,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -596,7 +614,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -605,7 +623,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -632,7 +652,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema | |=== @@ -641,7 +661,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 201 - Created +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -689,7 +713,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -716,7 +742,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -725,7 +751,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -752,7 +780,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema | |=== @@ -761,7 +789,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 201 - Created +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`KubeletConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/machine-apis-index.adoc b/rest_api/machine_apis/machine-apis-index.adoc index 4d37f61d6daa..5cedf4735ecb 100644 --- a/rest_api/machine_apis/machine-apis-index.adoc +++ b/rest_api/machine_apis/machine-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machine-apis"] = Machine APIs ifdef::product-title[] diff --git a/rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc b/rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc index ed4d1cab489a..b79cd2a51e87 100644 --- a/rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc +++ b/rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machine-machine-openshift-io-v1beta1"] = Machine [machine.openshift.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | MachineStatus defines the observed state of Machine |=== -..spec +=== .spec Description:: + -- @@ -83,7 +85,7 @@ Type:: | The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. |=== -..spec.metadata +=== .spec.metadata Description:: + -- @@ -132,7 +134,7 @@ Type:: | OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. |=== -..spec.metadata.ownerReferences +=== .spec.metadata.ownerReferences Description:: + -- @@ -145,7 +147,7 @@ Type:: -..spec.metadata.ownerReferences[] +=== .spec.metadata.ownerReferences[] Description:: + -- @@ -192,7 +194,7 @@ Required:: | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |=== -..spec.providerSpec +=== .spec.providerSpec Description:: + -- @@ -214,7 +216,7 @@ Type:: | Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config. |=== -..spec.taints +=== .spec.taints Description:: + -- @@ -227,7 +229,7 @@ Type:: -..spec.taints[] +=== .spec.taints[] Description:: + -- @@ -264,7 +266,7 @@ Required:: | The taint value corresponding to the taint key. |=== -..status +=== .status Description:: + -- @@ -330,7 +332,7 @@ Type:: | ProviderStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field. |=== -..status.addresses +=== .status.addresses Description:: + -- @@ -343,7 +345,7 @@ Type:: -..status.addresses[] +=== .status.addresses[] Description:: + -- @@ -372,7 +374,7 @@ Required:: | Node address type, one of Hostname, ExternalIP or InternalIP. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -385,7 +387,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -430,7 +432,7 @@ Required:: | Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. |=== -..status.lastOperation +=== .status.lastOperation Description:: + -- @@ -464,7 +466,7 @@ Type:: | Type is the type of operation which was last performed. E.g. Create, Delete, Update etc |=== -..status.nodeRef +=== .status.nodeRef Description:: + -- @@ -591,7 +593,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinelist-machine-openshift-io-v1beta1[`MachineList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineList[`MachineList`] schema +| 401 - Unauthorized +| Empty |=== @@ -669,7 +673,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -726,7 +732,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinelist-machine-openshift-io-v1beta1[`MachineList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineList[`MachineList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -753,7 +761,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema | |=== @@ -762,7 +770,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 201 - Created +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 202 - Accepted +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== @@ -819,7 +833,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -828,7 +842,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -855,7 +873,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -882,7 +902,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -891,7 +911,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -918,7 +940,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema | |=== @@ -927,7 +949,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 201 - Created +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== @@ -978,7 +1004,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1005,7 +1033,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1014,7 +1042,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1041,7 +1071,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema | |=== @@ -1050,7 +1080,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine machine.openshift.io/v1beta1`] +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 201 - Created +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`Machine`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc b/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc index 82de36fb203a..434311787fa1 100644 --- a/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc +++ b/rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machineconfig-machineconfiguration-openshift-io-v1"] = MachineConfig [machineconfiguration.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | MachineConfigSpec is the spec for MachineConfig |=== -..spec +=== .spec Description:: + -- @@ -165,7 +167,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -222,7 +226,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machineconfiglist-machineconfiguration-openshift-io-v1[`MachineConfigList machineconfiguration.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.machineconfiguration.v1.MachineConfigList[`MachineConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -249,7 +255,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema | |=== @@ -258,7 +264,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 201 - Created +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 202 - Accepted +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -312,7 +324,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -321,7 +333,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -348,7 +364,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -375,7 +393,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -384,7 +402,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -411,7 +431,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema | |=== @@ -420,7 +440,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 201 - Created +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`MachineConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc b/rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc index 89d7eeea0309..7b52c9919f54 100644 --- a/rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc +++ b/rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machineconfigpool-machineconfiguration-openshift-io-v1"] = MachineConfigPool [machineconfiguration.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | MachineConfigPoolStatus is the status for MachineConfigPool resource. |=== -..spec +=== .spec Description:: + -- @@ -83,7 +85,7 @@ Type:: | paused specifies whether or not changes to this machine config pool should be stopped. This includes generating new desiredMachineConfig and update of machines. |=== -..spec.configuration +=== .spec.configuration Description:: + -- @@ -137,7 +139,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..spec.configuration.source +=== .spec.configuration.source Description:: + -- @@ -150,7 +152,7 @@ Type:: -..spec.configuration.source[] +=== .spec.configuration.source[] Description:: + -- @@ -196,7 +198,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..spec.machineConfigSelector +=== .spec.machineConfigSelector Description:: + -- @@ -226,7 +228,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.machineConfigSelector.matchExpressions +=== .spec.machineConfigSelector.matchExpressions Description:: + -- @@ -239,7 +241,7 @@ Type:: -..spec.machineConfigSelector.matchExpressions[] +=== .spec.machineConfigSelector.matchExpressions[] Description:: + -- @@ -272,7 +274,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.nodeSelector +=== .spec.nodeSelector Description:: + -- @@ -302,7 +304,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.nodeSelector.matchExpressions +=== .spec.nodeSelector.matchExpressions Description:: + -- @@ -315,7 +317,7 @@ Type:: -..spec.nodeSelector.matchExpressions[] +=== .spec.nodeSelector.matchExpressions[] Description:: + -- @@ -348,7 +350,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..status +=== .status Description:: + -- @@ -402,7 +404,7 @@ Type:: | updatedMachineCount represents the total number of machines targeted by the pool that have the CurrentMachineConfig as their config. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -415,7 +417,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -453,7 +455,7 @@ Type:: | type of the condition, currently ('Done', 'Updating', 'Failed'). |=== -..status.configuration +=== .status.configuration Description:: + -- @@ -507,7 +509,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.configuration.source +=== .status.configuration.source Description:: + -- @@ -520,7 +522,7 @@ Type:: -..status.configuration.source[] +=== .status.configuration.source[] Description:: + -- @@ -652,7 +654,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -709,7 +713,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machineconfigpoollist-machineconfiguration-openshift-io-v1[`MachineConfigPoolList machineconfiguration.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.machineconfiguration.v1.MachineConfigPoolList[`MachineConfigPoolList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -736,7 +742,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema | |=== @@ -745,7 +751,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 201 - Created +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 202 - Accepted +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== @@ -799,7 +811,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -808,7 +820,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -835,7 +851,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -862,7 +880,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -871,7 +889,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -898,7 +918,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema | |=== @@ -907,7 +927,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 201 - Created +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== @@ -955,7 +979,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -982,7 +1008,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -991,7 +1017,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1018,7 +1046,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema | |=== @@ -1027,7 +1055,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool machineconfiguration.openshift.io/v1`] +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 201 - Created +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`MachineConfigPool`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc b/rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc index 3b81bd06bd01..f9462b5a597f 100644 --- a/rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc +++ b/rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machinehealthcheck-machine-openshift-io-v1beta1"] = MachineHealthCheck [machine.openshift.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | Most recently observed status of MachineHealthCheck resource |=== -..spec +=== .spec Description:: + -- @@ -91,7 +93,7 @@ Required:: | UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy. |=== -..spec.remediationTemplate +=== .spec.remediationTemplate Description:: + -- @@ -138,7 +140,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -168,7 +170,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -181,7 +183,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -214,7 +216,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.unhealthyConditions +=== .spec.unhealthyConditions Description:: + -- @@ -227,7 +229,7 @@ Type:: -..spec.unhealthyConditions[] +=== .spec.unhealthyConditions[] Description:: + -- @@ -261,7 +263,7 @@ Required:: | |=== -..status +=== .status Description:: + -- @@ -302,7 +304,7 @@ Required:: | RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -315,7 +317,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -441,7 +443,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinehealthchecklist-machine-openshift-io-v1beta1[`MachineHealthCheckList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineHealthCheckList[`MachineHealthCheckList`] schema +| 401 - Unauthorized +| Empty |=== @@ -519,7 +523,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -576,7 +582,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinehealthchecklist-machine-openshift-io-v1beta1[`MachineHealthCheckList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineHealthCheckList[`MachineHealthCheckList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -603,7 +611,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema | |=== @@ -612,7 +620,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 201 - Created +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 202 - Accepted +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== @@ -669,7 +683,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -678,7 +692,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -705,7 +723,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -732,7 +752,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -741,7 +761,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -768,7 +790,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema | |=== @@ -777,7 +799,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 201 - Created +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== @@ -828,7 +854,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -855,7 +883,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -864,7 +892,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -891,7 +921,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema | |=== @@ -900,7 +930,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck machine.openshift.io/v1beta1`] +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 201 - Created +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`MachineHealthCheck`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc b/rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc index 3d235c6e7e29..7969e9765f85 100644 --- a/rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc +++ b/rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="machineset-machine-openshift-io-v1beta1"] = MachineSet [machine.openshift.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | MachineSetStatus defines the observed state of MachineSet |=== -..spec +=== .spec Description:: + -- @@ -85,7 +87,7 @@ Required:: | Template is the object that describes the machine that will be created if insufficient replicas are detected. |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -115,7 +117,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -128,7 +130,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -161,7 +163,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.template +=== .spec.template Description:: + -- @@ -187,7 +189,7 @@ Type:: | Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -..spec.template.metadata +=== .spec.template.metadata Description:: + -- @@ -236,7 +238,7 @@ Type:: | OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. |=== -..spec.template.metadata.ownerReferences +=== .spec.template.metadata.ownerReferences Description:: + -- @@ -249,7 +251,7 @@ Type:: -..spec.template.metadata.ownerReferences[] +=== .spec.template.metadata.ownerReferences[] Description:: + -- @@ -296,7 +298,7 @@ Required:: | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |=== -..spec.template.spec +=== .spec.template.spec Description:: + -- @@ -334,7 +336,7 @@ Type:: | The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. |=== -..spec.template.spec.metadata +=== .spec.template.spec.metadata Description:: + -- @@ -383,7 +385,7 @@ Type:: | OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. |=== -..spec.template.spec.metadata.ownerReferences +=== .spec.template.spec.metadata.ownerReferences Description:: + -- @@ -396,7 +398,7 @@ Type:: -..spec.template.spec.metadata.ownerReferences[] +=== .spec.template.spec.metadata.ownerReferences[] Description:: + -- @@ -443,7 +445,7 @@ Required:: | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |=== -..spec.template.spec.providerSpec +=== .spec.template.spec.providerSpec Description:: + -- @@ -465,7 +467,7 @@ Type:: | Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config. |=== -..spec.template.spec.taints +=== .spec.template.spec.taints Description:: + -- @@ -478,7 +480,7 @@ Type:: -..spec.template.spec.taints[] +=== .spec.template.spec.taints[] Description:: + -- @@ -515,7 +517,7 @@ Required:: | The taint value corresponding to the taint key. |=== -..status +=== .status Description:: + -- @@ -650,7 +652,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinesetlist-machine-openshift-io-v1beta1[`MachineSetList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineSetList[`MachineSetList`] schema +| 401 - Unauthorized +| Empty |=== @@ -728,7 +732,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -785,7 +791,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#machinesetlist-machine-openshift-io-v1beta1[`MachineSetList machine.openshift.io/v1beta1`] +| xref:../objects/index.adoc#io.openshift.machine.v1beta1.MachineSetList[`MachineSetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -812,7 +820,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema | |=== @@ -821,7 +829,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 201 - Created +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 202 - Accepted +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== @@ -878,7 +892,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -887,7 +901,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -914,7 +932,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -941,7 +961,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -950,7 +970,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -977,7 +999,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema | |=== @@ -986,7 +1008,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 201 - Created +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== @@ -1037,7 +1063,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1064,7 +1092,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1073,7 +1101,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1100,7 +1130,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema | |=== @@ -1109,7 +1139,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 201 - Created +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== @@ -1160,7 +1194,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1187,7 +1223,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1196,7 +1232,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1223,7 +1261,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema | |=== @@ -1232,7 +1270,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet machine.openshift.io/v1beta1`] +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 201 - Created +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`MachineSet`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc b/rest_api/metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc index 37645b548eeb..ad18c2efd2fd 100644 --- a/rest_api/metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc +++ b/rest_api/metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="apirequestcount-apiserver-openshift-io-v1"] = APIRequestCount [apiserver.openshift.io/v1] ifdef::product-title[] @@ -10,7 +12,8 @@ toc::[] Description:: + -- -APIRequestCount tracks requests made to an API. The instance name must be of the form `resource.version.group`, matching the resource. +APIRequestCount tracks requests made to an API. The instance name must be of the form `resource.version.group`, matching the resource. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -35,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +50,7 @@ Required:: | status contains the observed state of the resource. |=== -..spec +=== .spec Description:: + -- @@ -69,7 +72,7 @@ Type:: | numberOfUsersToReport is the number of users to include in the report. If unspecified or zero, the default is ten. This is default is subject to change. |=== -..status +=== .status Description:: + -- @@ -116,7 +119,7 @@ Type:: | requestCount is a sum of all requestCounts across all current hours, nodes, and users. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -129,7 +132,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -178,7 +181,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..status.currentHour +=== .status.currentHour Description:: + -- @@ -208,7 +211,7 @@ Type:: | requestCount is a sum of all requestCounts across nodes. |=== -..status.currentHour.byNode +=== .status.currentHour.byNode Description:: + -- @@ -221,7 +224,7 @@ Type:: -..status.currentHour.byNode[] +=== .status.currentHour.byNode[] Description:: + -- @@ -255,7 +258,7 @@ Type:: | requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users. |=== -..status.currentHour.byNode[].byUser +=== .status.currentHour.byNode[].byUser Description:: + -- @@ -268,7 +271,7 @@ Type:: -..status.currentHour.byNode[].byUser[] +=== .status.currentHour.byNode[].byUser[] Description:: + -- @@ -306,7 +309,7 @@ Type:: | userName that made the request. |=== -..status.currentHour.byNode[].byUser[].byVerb +=== .status.currentHour.byNode[].byUser[].byVerb Description:: + -- @@ -319,7 +322,7 @@ Type:: -..status.currentHour.byNode[].byUser[].byVerb[] +=== .status.currentHour.byNode[].byUser[].byVerb[] Description:: + -- @@ -345,7 +348,7 @@ Type:: | verb of API request (get, list, create, etc...) |=== -..status.last24h +=== .status.last24h Description:: + -- @@ -358,7 +361,7 @@ Type:: -..status.last24h[] +=== .status.last24h[] Description:: + -- @@ -388,7 +391,7 @@ Type:: | requestCount is a sum of all requestCounts across nodes. |=== -..status.last24h[].byNode +=== .status.last24h[].byNode Description:: + -- @@ -401,7 +404,7 @@ Type:: -..status.last24h[].byNode[] +=== .status.last24h[].byNode[] Description:: + -- @@ -435,7 +438,7 @@ Type:: | requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users. |=== -..status.last24h[].byNode[].byUser +=== .status.last24h[].byNode[].byUser Description:: + -- @@ -448,7 +451,7 @@ Type:: -..status.last24h[].byNode[].byUser[] +=== .status.last24h[].byNode[].byUser[] Description:: + -- @@ -486,7 +489,7 @@ Type:: | userName that made the request. |=== -..status.last24h[].byNode[].byUser[].byVerb +=== .status.last24h[].byNode[].byUser[].byVerb Description:: + -- @@ -499,7 +502,7 @@ Type:: -..status.last24h[].byNode[].byUser[].byVerb[] +=== .status.last24h[].byNode[].byUser[].byVerb[] Description:: + -- @@ -611,7 +614,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -668,7 +673,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#apirequestcountlist-apiserver-openshift-io-v1[`APIRequestCountList apiserver.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.apiserver.v1.APIRequestCountList[`APIRequestCountList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -695,7 +702,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema | |=== @@ -704,7 +711,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 201 - Created +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 202 - Accepted +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== @@ -758,7 +771,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -767,7 +780,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -794,7 +811,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -821,7 +840,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -830,7 +849,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -857,7 +878,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema | |=== @@ -866,7 +887,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 201 - Created +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== @@ -914,7 +939,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -941,7 +968,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -950,7 +977,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -977,7 +1006,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema | |=== @@ -986,7 +1015,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount apiserver.openshift.io/v1`] +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 201 - Created +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`APIRequestCount`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/binding-v1.adoc b/rest_api/metadata_apis/binding-v1.adoc new file mode 100644 index 000000000000..740297c6a880 --- /dev/null +++ b/rest_api/metadata_apis/binding-v1.adoc @@ -0,0 +1,223 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="binding-v1"] += Binding [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. +-- + +Type:: + `object` + +Required:: + - `target` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `target` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +|=== +=== .target +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/namespaces/{namespace}/bindings` +- `POST`: create a Binding +* `/api/v1/namespaces/{namespace}/pods/{name}/binding` +- `POST`: create binding of a Pod + + +=== /api/v1/namespaces/{namespace}/bindings + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create a Binding + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 201 - Created +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 202 - Accepted +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/pods/{name}/binding + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Binding +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create binding of a Pod + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 201 - Created +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 202 - Accepted +| xref:../metadata_apis/binding-v1.adoc#binding-v1[`Binding`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/metadata_apis/componentstatus-v1.adoc b/rest_api/metadata_apis/componentstatus-v1.adoc new file mode 100644 index 000000000000..b25e71c4859d --- /dev/null +++ b/rest_api/metadata_apis/componentstatus-v1.adoc @@ -0,0 +1,213 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="componentstatus-v1"] += ComponentStatus [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `conditions` +| `array` +| List of component conditions observed + +| `conditions[]` +| `object` +| Information about the condition of a component. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +|=== +=== .conditions +Description:: ++ +-- +List of component conditions observed +-- + +Type:: + `array` + + + + +=== .conditions[] +Description:: ++ +-- +Information about the condition of a component. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `error` +| `string` +| Condition error code for a component. For example, a health check error code. + +| `message` +| `string` +| Message about the condition for a component. For example, information about a health check. + +| `status` +| `string` +| Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". + +| `type` +| `string` +| Type of condition for a component. Valid value: "Healthy" + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/componentstatuses` +- `GET`: list objects of kind ComponentStatus +* `/api/v1/componentstatuses/{name}` +- `GET`: read the specified ComponentStatus + + +=== /api/v1/componentstatuses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind ComponentStatus + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ComponentStatusList[`ComponentStatusList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/componentstatuses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ComponentStatus +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ComponentStatus + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/componentstatus-v1.adoc#componentstatus-v1[`ComponentStatus`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/metadata_apis/configmap-v1.adoc b/rest_api/metadata_apis/configmap-v1.adoc new file mode 100644 index 000000000000..31989c89e8f2 --- /dev/null +++ b/rest_api/metadata_apis/configmap-v1.adoc @@ -0,0 +1,721 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="configmap-v1"] += ConfigMap [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ConfigMap holds configuration data for pods to consume. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `binaryData` +| `object (string)` +| 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. + +| `data` +| `object (string)` +| 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. + +| `immutable` +| `boolean` +| 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. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/configmaps` +- `GET`: list or watch objects of kind ConfigMap +* `/api/v1/watch/configmaps` +- `GET`: watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/configmaps` +- `DELETE`: delete collection of ConfigMap +- `GET`: list or watch objects of kind ConfigMap +- `POST`: create a ConfigMap +* `/api/v1/watch/namespaces/{namespace}/configmaps` +- `GET`: watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/configmaps/{name}` +- `DELETE`: delete a ConfigMap +- `GET`: read the specified ConfigMap +- `PATCH`: partially update the specified ConfigMap +- `PUT`: replace the specified ConfigMap +* `/api/v1/watch/namespaces/{namespace}/configmaps/{name}` +- `GET`: watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/configmaps + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ConfigMap + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapList[`ConfigMapList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/configmaps + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/configmaps + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapList[`ConfigMapList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 201 - Created +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 202 - Accepted +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/configmaps + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/configmaps/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ConfigMap +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ConfigMap + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 201 - Created +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified ConfigMap + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 201 - Created +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`ConfigMap`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/configmaps/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ConfigMap +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/metadata_apis/controllerrevision-apps-v1.adoc b/rest_api/metadata_apis/controllerrevision-apps-v1.adoc index 8d79ecdea9a6..b1628358fb32 100644 --- a/rest_api/metadata_apis/controllerrevision-apps-v1.adoc +++ b/rest_api/metadata_apis/controllerrevision-apps-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="controllerrevision-apps-v1"] = ControllerRevision [apps/v1] ifdef::product-title[] @@ -31,7 +33,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `data` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | Data is the serialized representation of the state. | `kind` @@ -39,7 +41,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `revision` @@ -54,15 +56,21 @@ The following API endpoints are available: * `/apis/apps/v1/controllerrevisions` - `GET`: list or watch objects of kind ControllerRevision +* `/apis/apps/v1/watch/controllerrevisions` +- `GET`: watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/controllerrevisions` - `DELETE`: delete collection of ControllerRevision - `GET`: list or watch objects of kind ControllerRevision - `POST`: create a ControllerRevision +* `/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions` +- `GET`: watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}` - `DELETE`: delete a ControllerRevision - `GET`: read the specified ControllerRevision - `PATCH`: partially update the specified ControllerRevision - `PUT`: replace the specified ControllerRevision +* `/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}` +- `GET`: watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/apps/v1/controllerrevisions @@ -124,7 +132,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#controllerrevisionlist-apps-v1[`ControllerRevisionList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.ControllerRevisionList[`ControllerRevisionList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/controllerrevisions + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -207,7 +282,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -216,7 +291,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -273,7 +350,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#controllerrevisionlist-apps-v1[`ControllerRevisionList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.ControllerRevisionList[`ControllerRevisionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -300,7 +379,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema | |=== @@ -309,7 +388,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 201 - Created +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 202 - Accepted +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -366,7 +524,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -375,7 +533,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -390,7 +552,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -420,7 +584,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -429,7 +593,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 201 - Created +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -456,7 +624,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema | |=== @@ -465,7 +633,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision apps/v1`] +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 201 - Created +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`ControllerRevision`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ControllerRevision +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/event-events-k8s-io-v1.adoc b/rest_api/metadata_apis/event-events-k8s-io-v1.adoc index 58ca1f11d267..b2d589143c5d 100644 --- a/rest_api/metadata_apis/event-events-k8s-io-v1.adoc +++ b/rest_api/metadata_apis/event-events-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="event-events-k8s-io-v1"] = Event [events.k8s.io/v1] ifdef::product-title[] @@ -39,19 +41,19 @@ Required:: | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | `deprecatedFirstTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | `deprecatedLastTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | `deprecatedSource` -| xref:../objects/index.adoc#eventsource-core-v1[`EventSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EventSource[`EventSource`] | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | `eventTime` -| xref:../objects/index.adoc#microtime-meta-v1[`MicroTime meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] | eventTime is the time when this Event was first observed. It is required. | `kind` @@ -59,7 +61,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `note` @@ -71,11 +73,11 @@ Required:: | reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. | `regarding` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference[`ObjectReference`] | regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. | `related` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference[`ObjectReference`] | related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. | `reportingController` @@ -95,7 +97,7 @@ Required:: | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. |=== -..series +=== .series Description:: + -- @@ -120,7 +122,7 @@ Required:: | count is the number of occurrences in this series up to the last heartbeat time. | `lastObservedTime` -| xref:../objects/index.adoc#microtime-meta-v1[`MicroTime meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] | lastObservedTime is the time when last Event from the series was seen before last heartbeat. |=== @@ -131,15 +133,21 @@ The following API endpoints are available: * `/apis/events.k8s.io/v1/events` - `GET`: list or watch objects of kind Event +* `/apis/events.k8s.io/v1/watch/events` +- `GET`: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/events.k8s.io/v1/namespaces/{namespace}/events` - `DELETE`: delete collection of Event - `GET`: list or watch objects of kind Event - `POST`: create an Event +* `/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events` +- `GET`: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}` - `DELETE`: delete an Event - `GET`: read the specified Event - `PATCH`: partially update the specified Event - `PUT`: replace the specified Event +* `/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}` +- `GET`: watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/events.k8s.io/v1/events @@ -201,7 +209,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#eventlist-events-k8s-io-v1[`EventList events.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.events.v1.EventList[`EventList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/events.k8s.io/v1/watch/events + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -284,7 +359,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -293,7 +368,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -350,7 +427,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#eventlist-events-k8s-io-v1[`EventList events.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.events.v1.EventList[`EventList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -377,7 +456,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema | |=== @@ -386,7 +465,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 202 - Accepted +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -443,7 +601,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -452,7 +610,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -467,7 +629,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -497,7 +661,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -506,7 +670,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -533,7 +701,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema | |=== @@ -542,7 +710,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event events.k8s.io/v1`] +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Event +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/event-v1.adoc b/rest_api/metadata_apis/event-v1.adoc new file mode 100644 index 000000000000..384511cca06e --- /dev/null +++ b/rest_api/metadata_apis/event-v1.adoc @@ -0,0 +1,912 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="event-v1"] += Event [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. +-- + +Type:: + `object` + +Required:: + - `metadata` + - `involvedObject` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `action` +| `string` +| What action was taken/failed regarding to the Regarding object. + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `count` +| `integer` +| The number of times this event has occurred. + +| `eventTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] +| Time when this Event was first observed. + +| `firstTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) + +| `involvedObject` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `lastTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| The time at which the most recent occurrence of this event was recorded. + +| `message` +| `string` +| A human-readable description of the status of this operation. + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `reason` +| `string` +| This should be a short, machine understandable string that gives the reason for the transition into the object's current status. + +| `related` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +| `reportingComponent` +| `string` +| Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. + +| `reportingInstance` +| `string` +| ID of the controller instance, e.g. `kubelet-xyzf`. + +| `series` +| `object` +| EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. + +| `source` +| `object` +| EventSource contains information for an event. + +| `type` +| `string` +| Type of this event (Normal, Warning), new types could be added in the future + +|=== +=== .involvedObject +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .related +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .series +Description:: ++ +-- +EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `count` +| `integer` +| Number of occurrences in this series up to the last heartbeat time + +| `lastObservedTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] +| Time of the last occurrence observed + +|=== +=== .source +Description:: ++ +-- +EventSource contains information for an event. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `component` +| `string` +| Component from which the event is generated. + +| `host` +| `string` +| Node name on which the event is generated. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/events` +- `GET`: list or watch objects of kind Event +* `/api/v1/watch/events` +- `GET`: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/events` +- `DELETE`: delete collection of Event +- `GET`: list or watch objects of kind Event +- `POST`: create an Event +* `/api/v1/watch/namespaces/{namespace}/events` +- `GET`: watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/events/{name}` +- `DELETE`: delete an Event +- `GET`: read the specified Event +- `PATCH`: partially update the specified Event +- `PUT`: replace the specified Event +* `/api/v1/watch/namespaces/{namespace}/events/{name}` +- `GET`: watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/events + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Event + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.EventList[`EventList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/events + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/events + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.EventList[`EventList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create an Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 202 - Accepted +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/events + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/events/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Event +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete an Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Event + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Event + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 201 - Created +| xref:../metadata_apis/event-v1.adoc#event-v1[`Event`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/events/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Event +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/metadata_apis/lease-coordination-k8s-io-v1.adoc b/rest_api/metadata_apis/lease-coordination-k8s-io-v1.adoc index 4b1b5e432314..aa6ed580dfdc 100644 --- a/rest_api/metadata_apis/lease-coordination-k8s-io-v1.adoc +++ b/rest_api/metadata_apis/lease-coordination-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="lease-coordination-k8s-io-v1"] = Lease [coordination.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | LeaseSpec is a specification of a Lease. |=== -..spec +=== .spec Description:: + -- @@ -59,7 +61,7 @@ Type:: | Property | Type | Description | `acquireTime` -| xref:../objects/index.adoc#microtime-meta-v1[`MicroTime meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] | acquireTime is a time when the current lease was acquired. | `holderIdentity` @@ -75,7 +77,7 @@ Type:: | leaseTransitions is the number of transitions of a lease between holders. | `renewTime` -| xref:../objects/index.adoc#microtime-meta-v1[`MicroTime meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime[`MicroTime`] | renewTime is a time when the current holder of a lease has last updated the lease. |=== @@ -86,15 +88,21 @@ The following API endpoints are available: * `/apis/coordination.k8s.io/v1/leases` - `GET`: list or watch objects of kind Lease +* `/apis/coordination.k8s.io/v1/watch/leases` +- `GET`: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases` - `DELETE`: delete collection of Lease - `GET`: list or watch objects of kind Lease - `POST`: create a Lease +* `/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases` +- `GET`: watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}` - `DELETE`: delete a Lease - `GET`: read the specified Lease - `PATCH`: partially update the specified Lease - `PUT`: replace the specified Lease +* `/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}` +- `GET`: watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/coordination.k8s.io/v1/leases @@ -156,7 +164,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#leaselist-coordination-k8s-io-v1[`LeaseList coordination.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.coordination.v1.LeaseList[`LeaseList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/coordination.k8s.io/v1/watch/leases + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -239,7 +314,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -248,7 +323,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -305,7 +382,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#leaselist-coordination-k8s-io-v1[`LeaseList coordination.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.coordination.v1.LeaseList[`LeaseList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -332,7 +411,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema | |=== @@ -341,7 +420,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 201 - Created +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 202 - Accepted +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -398,7 +556,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -407,7 +565,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -422,7 +584,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -452,7 +616,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -461,7 +625,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 201 - Created +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -488,7 +656,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema | |=== @@ -497,7 +665,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease coordination.k8s.io/v1`] +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 201 - Created +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`Lease`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Lease +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/metadata-apis-index.adoc b/rest_api/metadata_apis/metadata-apis-index.adoc index 05028509838f..c7264e185d72 100644 --- a/rest_api/metadata_apis/metadata-apis-index.adoc +++ b/rest_api/metadata_apis/metadata-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="metadata-apis"] = Metadata APIs ifdef::product-title[] @@ -11,13 +13,14 @@ toc::[] Description:: + -- -APIRequestCount tracks requests made to an API. The instance name must be of the form `resource.version.group`, matching the resource. +APIRequestCount tracks requests made to an API. The instance name must be of the form `resource.version.group`, matching the resource. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: `object` -== Binding [core/v1] +== Binding [v1] Description:: + @@ -28,7 +31,7 @@ Binding ties one object to another; for example, a pod is bound to a node by a s Type:: `object` -== ComponentStatus [core/v1] +== ComponentStatus [v1] Description:: + @@ -39,7 +42,7 @@ ComponentStatus (and ComponentStatusList) holds the cluster validation info. Dep Type:: `object` -== ConfigMap [core/v1] +== ConfigMap [v1] Description:: + @@ -72,7 +75,7 @@ Event is a report of an event somewhere in the cluster. It generally denotes som Type:: `object` -== Event [core/v1] +== Event [v1] Description:: + @@ -94,7 +97,7 @@ Lease defines a lease concept. Type:: `object` -== Namespace [core/v1] +== Namespace [v1] Description:: + diff --git a/rest_api/metadata_apis/namespace-v1.adoc b/rest_api/metadata_apis/namespace-v1.adoc new file mode 100644 index 000000000000..be00e73b6f6b --- /dev/null +++ b/rest_api/metadata_apis/namespace-v1.adoc @@ -0,0 +1,776 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="namespace-v1"] += Namespace [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Namespace provides a scope for Names. Use of multiple namespaces is optional. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| NamespaceSpec describes the attributes on a Namespace. + +| `status` +| `object` +| NamespaceStatus is information about the current status of a Namespace. + +|=== +=== .spec +Description:: ++ +-- +NamespaceSpec describes the attributes on a Namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `finalizers` +| `array (string)` +| Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + +|=== +=== .status +Description:: ++ +-- +NamespaceStatus is information about the current status of a Namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditions` +| `array` +| Represents the latest available observations of a namespace's current state. + +| `conditions[]` +| `object` +| NamespaceCondition contains details about state of namespace. + +| `phase` +| `string` +| Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + +|=== +=== .status.conditions +Description:: ++ +-- +Represents the latest available observations of a namespace's current state. +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +NamespaceCondition contains details about state of namespace. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| + +| `message` +| `string` +| + +| `reason` +| `string` +| + +| `status` +| `string` +| Status of the condition, one of True, False, Unknown. + +| `type` +| `string` +| Type of namespace controller condition. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/namespaces` +- `GET`: list or watch objects of kind Namespace +- `POST`: create a Namespace +* `/api/v1/watch/namespaces` +- `GET`: watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{name}` +- `DELETE`: delete a Namespace +- `GET`: read the specified Namespace +- `PATCH`: partially update the specified Namespace +- `PUT`: replace the specified Namespace +* `/api/v1/watch/namespaces/{name}` +- `GET`: watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{name}/status` +- `GET`: read status of the specified Namespace +- `PATCH`: partially update status of the specified Namespace +- `PUT`: replace status of the specified Namespace +* `/api/v1/namespaces/{name}/finalize` +- `PUT`: replace finalize of the specified Namespace + + +=== /api/v1/namespaces + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.NamespaceList[`NamespaceList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 202 - Accepted +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Namespace +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Namespace + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Namespace +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Namespace +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified Namespace + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified Namespace + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{name}/finalize + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Namespace +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `PUT` + +Description:: + replace finalize of the specified Namespace + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 201 - Created +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`Namespace`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc index e0249309e34f..477f67658341 100644 --- a/rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="alertmanager-monitoring-coreos-com-v1"] = Alertmanager [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | Most recent observed status of the Alertmanager cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -..spec +=== .spec Description:: + -- @@ -156,6 +158,10 @@ Type:: | `string` | Log level for Alertmanager to be configured with. +| `minReadySeconds` +| `integer` +| Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. + | `nodeSelector` | `object (string)` | Define which Nodes the Pods are scheduled on. @@ -253,7 +259,7 @@ Type:: | Volume represents a named volume in a pod that may be accessed by any container in the pod. |=== -..spec.affinity +=== .spec.affinity Description:: + -- @@ -283,7 +289,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.affinity.nodeAffinity +=== .spec.affinity.nodeAffinity Description:: + -- @@ -313,7 +319,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -326,7 +332,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -355,7 +361,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -389,7 +395,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -402,7 +408,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -435,7 +441,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -448,7 +454,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -481,7 +487,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -509,7 +515,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -522,7 +528,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -556,7 +562,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -569,7 +575,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -602,7 +608,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -615,7 +621,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -648,7 +654,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity +=== .spec.affinity.podAffinity Description:: + -- @@ -682,7 +688,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -695,7 +701,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -724,7 +730,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -756,7 +762,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -786,7 +792,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -799,7 +805,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -832,7 +838,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -845,7 +851,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -877,7 +883,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -907,7 +913,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -920,7 +926,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -953,7 +959,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity +=== .spec.affinity.podAntiAffinity Description:: + -- @@ -987,7 +993,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1000,7 +1006,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1029,7 +1035,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -1061,7 +1067,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1091,7 +1097,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1104,7 +1110,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1137,7 +1143,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1150,7 +1156,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1182,7 +1188,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1212,7 +1218,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1225,7 +1231,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1258,7 +1264,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.alertmanagerConfigNamespaceSelector +=== .spec.alertmanagerConfigNamespaceSelector Description:: + -- @@ -1288,7 +1294,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.alertmanagerConfigNamespaceSelector.matchExpressions +=== .spec.alertmanagerConfigNamespaceSelector.matchExpressions Description:: + -- @@ -1301,7 +1307,7 @@ Type:: -..spec.alertmanagerConfigNamespaceSelector.matchExpressions[] +=== .spec.alertmanagerConfigNamespaceSelector.matchExpressions[] Description:: + -- @@ -1334,7 +1340,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.alertmanagerConfigSelector +=== .spec.alertmanagerConfigSelector Description:: + -- @@ -1364,7 +1370,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.alertmanagerConfigSelector.matchExpressions +=== .spec.alertmanagerConfigSelector.matchExpressions Description:: + -- @@ -1377,7 +1383,7 @@ Type:: -..spec.alertmanagerConfigSelector.matchExpressions[] +=== .spec.alertmanagerConfigSelector.matchExpressions[] Description:: + -- @@ -1410,7 +1416,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.containers +=== .spec.containers Description:: + -- @@ -1423,7 +1429,7 @@ Type:: -..spec.containers[] +=== .spec.containers[] Description:: + -- @@ -1551,7 +1557,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.containers[].env +=== .spec.containers[].env Description:: + -- @@ -1564,7 +1570,7 @@ Type:: -..spec.containers[].env[] +=== .spec.containers[].env[] Description:: + -- @@ -1596,7 +1602,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.containers[].env[].valueFrom +=== .spec.containers[].env[].valueFrom Description:: + -- @@ -1630,7 +1636,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.containers[].env[].valueFrom.configMapKeyRef +=== .spec.containers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -1662,7 +1668,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.containers[].env[].valueFrom.fieldRef +=== .spec.containers[].env[].valueFrom.fieldRef Description:: + -- @@ -1690,7 +1696,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.containers[].env[].valueFrom.resourceFieldRef +=== .spec.containers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -1722,7 +1728,7 @@ Required:: | Required: resource to select |=== -..spec.containers[].env[].valueFrom.secretKeyRef +=== .spec.containers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -1754,7 +1760,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.containers[].envFrom +=== .spec.containers[].envFrom Description:: + -- @@ -1767,7 +1773,7 @@ Type:: -..spec.containers[].envFrom[] +=== .spec.containers[].envFrom[] Description:: + -- @@ -1797,7 +1803,7 @@ Type:: | The Secret to select from |=== -..spec.containers[].envFrom[].configMapRef +=== .spec.containers[].envFrom[].configMapRef Description:: + -- @@ -1823,7 +1829,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.containers[].envFrom[].secretRef +=== .spec.containers[].envFrom[].secretRef Description:: + -- @@ -1849,7 +1855,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.containers[].lifecycle +=== .spec.containers[].lifecycle Description:: + -- @@ -1875,7 +1881,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.containers[].lifecycle.postStart +=== .spec.containers[].lifecycle.postStart Description:: + -- @@ -1905,7 +1911,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.postStart.exec +=== .spec.containers[].lifecycle.postStart.exec Description:: + -- @@ -1927,7 +1933,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.postStart.httpGet +=== .spec.containers[].lifecycle.postStart.httpGet Description:: + -- @@ -1971,7 +1977,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -1984,7 +1990,7 @@ Type:: -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -2013,7 +2019,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.postStart.tcpSocket +=== .spec.containers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -2041,7 +2047,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].lifecycle.preStop +=== .spec.containers[].lifecycle.preStop Description:: + -- @@ -2071,7 +2077,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.preStop.exec +=== .spec.containers[].lifecycle.preStop.exec Description:: + -- @@ -2093,7 +2099,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.preStop.httpGet +=== .spec.containers[].lifecycle.preStop.httpGet Description:: + -- @@ -2137,7 +2143,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -2150,7 +2156,7 @@ Type:: -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -2179,7 +2185,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.preStop.tcpSocket +=== .spec.containers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -2207,7 +2213,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].livenessProbe +=== .spec.containers[].livenessProbe Description:: + -- @@ -2257,7 +2263,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].livenessProbe.exec +=== .spec.containers[].livenessProbe.exec Description:: + -- @@ -2279,7 +2285,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].livenessProbe.httpGet +=== .spec.containers[].livenessProbe.httpGet Description:: + -- @@ -2323,7 +2329,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].livenessProbe.httpGet.httpHeaders +=== .spec.containers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -2336,7 +2342,7 @@ Type:: -..spec.containers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.containers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -2365,7 +2371,7 @@ Required:: | The header field value |=== -..spec.containers[].livenessProbe.tcpSocket +=== .spec.containers[].livenessProbe.tcpSocket Description:: + -- @@ -2393,7 +2399,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].ports +=== .spec.containers[].ports Description:: + -- @@ -2406,7 +2412,7 @@ Type:: -..spec.containers[].ports[] +=== .spec.containers[].ports[] Description:: + -- @@ -2446,7 +2452,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.containers[].readinessProbe +=== .spec.containers[].readinessProbe Description:: + -- @@ -2496,7 +2502,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].readinessProbe.exec +=== .spec.containers[].readinessProbe.exec Description:: + -- @@ -2518,7 +2524,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].readinessProbe.httpGet +=== .spec.containers[].readinessProbe.httpGet Description:: + -- @@ -2562,7 +2568,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].readinessProbe.httpGet.httpHeaders +=== .spec.containers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -2575,7 +2581,7 @@ Type:: -..spec.containers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.containers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -2604,7 +2610,7 @@ Required:: | The header field value |=== -..spec.containers[].readinessProbe.tcpSocket +=== .spec.containers[].readinessProbe.tcpSocket Description:: + -- @@ -2632,7 +2638,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].resources +=== .spec.containers[].resources Description:: + -- @@ -2658,7 +2664,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.containers[].securityContext +=== .spec.containers[].securityContext Description:: + -- @@ -2716,7 +2722,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].securityContext.capabilities +=== .spec.containers[].securityContext.capabilities Description:: + -- @@ -2742,7 +2748,7 @@ Type:: | Removed capabilities |=== -..spec.containers[].securityContext.seLinuxOptions +=== .spec.containers[].securityContext.seLinuxOptions Description:: + -- @@ -2776,7 +2782,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.containers[].securityContext.windowsOptions +=== .spec.containers[].securityContext.windowsOptions Description:: + -- @@ -2806,7 +2812,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].startupProbe +=== .spec.containers[].startupProbe Description:: + -- @@ -2856,7 +2862,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].startupProbe.exec +=== .spec.containers[].startupProbe.exec Description:: + -- @@ -2878,7 +2884,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].startupProbe.httpGet +=== .spec.containers[].startupProbe.httpGet Description:: + -- @@ -2922,7 +2928,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].startupProbe.httpGet.httpHeaders +=== .spec.containers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -2935,7 +2941,7 @@ Type:: -..spec.containers[].startupProbe.httpGet.httpHeaders[] +=== .spec.containers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -2964,7 +2970,7 @@ Required:: | The header field value |=== -..spec.containers[].startupProbe.tcpSocket +=== .spec.containers[].startupProbe.tcpSocket Description:: + -- @@ -2992,7 +2998,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].volumeDevices +=== .spec.containers[].volumeDevices Description:: + -- @@ -3005,7 +3011,7 @@ Type:: -..spec.containers[].volumeDevices[] +=== .spec.containers[].volumeDevices[] Description:: + -- @@ -3034,7 +3040,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.containers[].volumeMounts +=== .spec.containers[].volumeMounts Description:: + -- @@ -3047,7 +3053,7 @@ Type:: -..spec.containers[].volumeMounts[] +=== .spec.containers[].volumeMounts[] Description:: + -- @@ -3092,7 +3098,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.imagePullSecrets +=== .spec.imagePullSecrets Description:: + -- @@ -3105,7 +3111,7 @@ Type:: -..spec.imagePullSecrets[] +=== .spec.imagePullSecrets[] Description:: + -- @@ -3127,7 +3133,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.initContainers +=== .spec.initContainers Description:: + -- @@ -3140,7 +3146,7 @@ Type:: -..spec.initContainers[] +=== .spec.initContainers[] Description:: + -- @@ -3268,7 +3274,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.initContainers[].env +=== .spec.initContainers[].env Description:: + -- @@ -3281,7 +3287,7 @@ Type:: -..spec.initContainers[].env[] +=== .spec.initContainers[].env[] Description:: + -- @@ -3313,7 +3319,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.initContainers[].env[].valueFrom +=== .spec.initContainers[].env[].valueFrom Description:: + -- @@ -3347,7 +3353,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.initContainers[].env[].valueFrom.configMapKeyRef +=== .spec.initContainers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -3379,7 +3385,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.initContainers[].env[].valueFrom.fieldRef +=== .spec.initContainers[].env[].valueFrom.fieldRef Description:: + -- @@ -3407,7 +3413,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.initContainers[].env[].valueFrom.resourceFieldRef +=== .spec.initContainers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -3439,7 +3445,7 @@ Required:: | Required: resource to select |=== -..spec.initContainers[].env[].valueFrom.secretKeyRef +=== .spec.initContainers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -3471,7 +3477,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.initContainers[].envFrom +=== .spec.initContainers[].envFrom Description:: + -- @@ -3484,7 +3490,7 @@ Type:: -..spec.initContainers[].envFrom[] +=== .spec.initContainers[].envFrom[] Description:: + -- @@ -3514,7 +3520,7 @@ Type:: | The Secret to select from |=== -..spec.initContainers[].envFrom[].configMapRef +=== .spec.initContainers[].envFrom[].configMapRef Description:: + -- @@ -3540,7 +3546,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.initContainers[].envFrom[].secretRef +=== .spec.initContainers[].envFrom[].secretRef Description:: + -- @@ -3566,7 +3572,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.initContainers[].lifecycle +=== .spec.initContainers[].lifecycle Description:: + -- @@ -3592,7 +3598,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.initContainers[].lifecycle.postStart +=== .spec.initContainers[].lifecycle.postStart Description:: + -- @@ -3622,7 +3628,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.postStart.exec +=== .spec.initContainers[].lifecycle.postStart.exec Description:: + -- @@ -3644,7 +3650,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.postStart.httpGet +=== .spec.initContainers[].lifecycle.postStart.httpGet Description:: + -- @@ -3688,7 +3694,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -3701,7 +3707,7 @@ Type:: -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -3730,7 +3736,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.postStart.tcpSocket +=== .spec.initContainers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -3758,7 +3764,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].lifecycle.preStop +=== .spec.initContainers[].lifecycle.preStop Description:: + -- @@ -3788,7 +3794,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.preStop.exec +=== .spec.initContainers[].lifecycle.preStop.exec Description:: + -- @@ -3810,7 +3816,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.preStop.httpGet +=== .spec.initContainers[].lifecycle.preStop.httpGet Description:: + -- @@ -3854,7 +3860,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -3867,7 +3873,7 @@ Type:: -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -3896,7 +3902,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.preStop.tcpSocket +=== .spec.initContainers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -3924,7 +3930,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].livenessProbe +=== .spec.initContainers[].livenessProbe Description:: + -- @@ -3974,7 +3980,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].livenessProbe.exec +=== .spec.initContainers[].livenessProbe.exec Description:: + -- @@ -3996,7 +4002,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].livenessProbe.httpGet +=== .spec.initContainers[].livenessProbe.httpGet Description:: + -- @@ -4040,7 +4046,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].livenessProbe.httpGet.httpHeaders +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -4053,7 +4059,7 @@ Type:: -..spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4082,7 +4088,7 @@ Required:: | The header field value |=== -..spec.initContainers[].livenessProbe.tcpSocket +=== .spec.initContainers[].livenessProbe.tcpSocket Description:: + -- @@ -4110,7 +4116,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].ports +=== .spec.initContainers[].ports Description:: + -- @@ -4123,7 +4129,7 @@ Type:: -..spec.initContainers[].ports[] +=== .spec.initContainers[].ports[] Description:: + -- @@ -4163,7 +4169,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.initContainers[].readinessProbe +=== .spec.initContainers[].readinessProbe Description:: + -- @@ -4213,7 +4219,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].readinessProbe.exec +=== .spec.initContainers[].readinessProbe.exec Description:: + -- @@ -4235,7 +4241,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].readinessProbe.httpGet +=== .spec.initContainers[].readinessProbe.httpGet Description:: + -- @@ -4279,7 +4285,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].readinessProbe.httpGet.httpHeaders +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -4292,7 +4298,7 @@ Type:: -..spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4321,7 +4327,7 @@ Required:: | The header field value |=== -..spec.initContainers[].readinessProbe.tcpSocket +=== .spec.initContainers[].readinessProbe.tcpSocket Description:: + -- @@ -4349,7 +4355,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].resources +=== .spec.initContainers[].resources Description:: + -- @@ -4375,7 +4381,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.initContainers[].securityContext +=== .spec.initContainers[].securityContext Description:: + -- @@ -4433,7 +4439,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].securityContext.capabilities +=== .spec.initContainers[].securityContext.capabilities Description:: + -- @@ -4459,7 +4465,7 @@ Type:: | Removed capabilities |=== -..spec.initContainers[].securityContext.seLinuxOptions +=== .spec.initContainers[].securityContext.seLinuxOptions Description:: + -- @@ -4493,7 +4499,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.initContainers[].securityContext.windowsOptions +=== .spec.initContainers[].securityContext.windowsOptions Description:: + -- @@ -4523,7 +4529,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].startupProbe +=== .spec.initContainers[].startupProbe Description:: + -- @@ -4573,7 +4579,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].startupProbe.exec +=== .spec.initContainers[].startupProbe.exec Description:: + -- @@ -4595,7 +4601,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].startupProbe.httpGet +=== .spec.initContainers[].startupProbe.httpGet Description:: + -- @@ -4639,7 +4645,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].startupProbe.httpGet.httpHeaders +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -4652,7 +4658,7 @@ Type:: -..spec.initContainers[].startupProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -4681,7 +4687,7 @@ Required:: | The header field value |=== -..spec.initContainers[].startupProbe.tcpSocket +=== .spec.initContainers[].startupProbe.tcpSocket Description:: + -- @@ -4709,7 +4715,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].volumeDevices +=== .spec.initContainers[].volumeDevices Description:: + -- @@ -4722,7 +4728,7 @@ Type:: -..spec.initContainers[].volumeDevices[] +=== .spec.initContainers[].volumeDevices[] Description:: + -- @@ -4751,7 +4757,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.initContainers[].volumeMounts +=== .spec.initContainers[].volumeMounts Description:: + -- @@ -4764,7 +4770,7 @@ Type:: -..spec.initContainers[].volumeMounts[] +=== .spec.initContainers[].volumeMounts[] Description:: + -- @@ -4809,7 +4815,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.podMetadata +=== .spec.podMetadata Description:: + -- @@ -4839,7 +4845,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.resources +=== .spec.resources Description:: + -- @@ -4865,7 +4871,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.securityContext +=== .spec.securityContext Description:: + -- @@ -4925,7 +4931,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.securityContext.seLinuxOptions +=== .spec.securityContext.seLinuxOptions Description:: + -- @@ -4959,7 +4965,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.securityContext.sysctls +=== .spec.securityContext.sysctls Description:: + -- @@ -4972,7 +4978,7 @@ Type:: -..spec.securityContext.sysctls[] +=== .spec.securityContext.sysctls[] Description:: + -- @@ -5001,7 +5007,7 @@ Required:: | Value of a property to set |=== -..spec.securityContext.windowsOptions +=== .spec.securityContext.windowsOptions Description:: + -- @@ -5031,7 +5037,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.storage +=== .spec.storage Description:: + -- @@ -5061,7 +5067,7 @@ Type:: | A PVC spec to be used by the Prometheus StatefulSets. |=== -..spec.storage.emptyDir +=== .spec.storage.emptyDir Description:: + -- @@ -5087,7 +5093,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.storage.volumeClaimTemplate +=== .spec.storage.volumeClaimTemplate Description:: + -- @@ -5125,7 +5131,7 @@ Type:: | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |=== -..spec.storage.volumeClaimTemplate.metadata +=== .spec.storage.volumeClaimTemplate.metadata Description:: + -- @@ -5155,7 +5161,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.storage.volumeClaimTemplate.spec +=== .spec.storage.volumeClaimTemplate.spec Description:: + -- @@ -5201,7 +5207,7 @@ Type:: | VolumeName is the binding reference to the PersistentVolume backing this claim. |=== -..spec.storage.volumeClaimTemplate.spec.dataSource +=== .spec.storage.volumeClaimTemplate.spec.dataSource Description:: + -- @@ -5234,7 +5240,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.storage.volumeClaimTemplate.spec.resources +=== .spec.storage.volumeClaimTemplate.spec.resources Description:: + -- @@ -5260,7 +5266,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.storage.volumeClaimTemplate.spec.selector +=== .spec.storage.volumeClaimTemplate.spec.selector Description:: + -- @@ -5290,7 +5296,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Description:: + -- @@ -5303,7 +5309,7 @@ Type:: -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Description:: + -- @@ -5336,7 +5342,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.storage.volumeClaimTemplate.status +=== .spec.storage.volumeClaimTemplate.status Description:: + -- @@ -5374,7 +5380,7 @@ Type:: | Phase represents the current phase of PersistentVolumeClaim. |=== -..spec.storage.volumeClaimTemplate.status.conditions +=== .spec.storage.volumeClaimTemplate.status.conditions Description:: + -- @@ -5387,7 +5393,7 @@ Type:: -..spec.storage.volumeClaimTemplate.status.conditions[] +=== .spec.storage.volumeClaimTemplate.status.conditions[] Description:: + -- @@ -5432,7 +5438,7 @@ Required:: | PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type |=== -..spec.tolerations +=== .spec.tolerations Description:: + -- @@ -5445,7 +5451,7 @@ Type:: -..spec.tolerations[] +=== .spec.tolerations[] Description:: + -- @@ -5483,7 +5489,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.topologySpreadConstraints +=== .spec.topologySpreadConstraints Description:: + -- @@ -5496,7 +5502,7 @@ Type:: -..spec.topologySpreadConstraints[] +=== .spec.topologySpreadConstraints[] Description:: + -- @@ -5534,7 +5540,7 @@ Required:: | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. |=== -..spec.topologySpreadConstraints[].labelSelector +=== .spec.topologySpreadConstraints[].labelSelector Description:: + -- @@ -5564,7 +5570,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.topologySpreadConstraints[].labelSelector.matchExpressions +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions Description:: + -- @@ -5577,7 +5583,7 @@ Type:: -..spec.topologySpreadConstraints[].labelSelector.matchExpressions[] +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Description:: + -- @@ -5610,7 +5616,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.volumeMounts +=== .spec.volumeMounts Description:: + -- @@ -5623,7 +5629,7 @@ Type:: -..spec.volumeMounts[] +=== .spec.volumeMounts[] Description:: + -- @@ -5668,7 +5674,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.volumes +=== .spec.volumes Description:: + -- @@ -5681,7 +5687,7 @@ Type:: -..spec.volumes[] +=== .spec.volumes[] Description:: + -- @@ -5817,7 +5823,7 @@ Required:: | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -..spec.volumes[].awsElasticBlockStore +=== .spec.volumes[].awsElasticBlockStore Description:: + -- @@ -5853,7 +5859,7 @@ Required:: | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |=== -..spec.volumes[].azureDisk +=== .spec.volumes[].azureDisk Description:: + -- @@ -5898,7 +5904,7 @@ Required:: | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |=== -..spec.volumes[].azureFile +=== .spec.volumes[].azureFile Description:: + -- @@ -5931,7 +5937,7 @@ Required:: | Share Name |=== -..spec.volumes[].cephfs +=== .spec.volumes[].cephfs Description:: + -- @@ -5975,7 +5981,7 @@ Required:: | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |=== -..spec.volumes[].cephfs.secretRef +=== .spec.volumes[].cephfs.secretRef Description:: + -- @@ -5997,7 +6003,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].cinder +=== .spec.volumes[].cinder Description:: + -- @@ -6033,7 +6039,7 @@ Required:: | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |=== -..spec.volumes[].cinder.secretRef +=== .spec.volumes[].cinder.secretRef Description:: + -- @@ -6055,7 +6061,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].configMap +=== .spec.volumes[].configMap Description:: + -- @@ -6093,7 +6099,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].configMap.items +=== .spec.volumes[].configMap.items Description:: + -- @@ -6106,7 +6112,7 @@ Type:: -..spec.volumes[].configMap.items[] +=== .spec.volumes[].configMap.items[] Description:: + -- @@ -6139,7 +6145,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].csi +=== .spec.volumes[].csi Description:: + -- @@ -6179,7 +6185,7 @@ Required:: | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. |=== -..spec.volumes[].csi.nodePublishSecretRef +=== .spec.volumes[].csi.nodePublishSecretRef Description:: + -- @@ -6201,7 +6207,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].downwardAPI +=== .spec.volumes[].downwardAPI Description:: + -- @@ -6231,7 +6237,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].downwardAPI.items +=== .spec.volumes[].downwardAPI.items Description:: + -- @@ -6244,7 +6250,7 @@ Type:: -..spec.volumes[].downwardAPI.items[] +=== .spec.volumes[].downwardAPI.items[] Description:: + -- @@ -6280,7 +6286,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].downwardAPI.items[].fieldRef +=== .spec.volumes[].downwardAPI.items[].fieldRef Description:: + -- @@ -6308,7 +6314,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -6340,7 +6346,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].emptyDir +=== .spec.volumes[].emptyDir Description:: + -- @@ -6366,7 +6372,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.volumes[].fc +=== .spec.volumes[].fc Description:: + -- @@ -6404,7 +6410,7 @@ Type:: | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |=== -..spec.volumes[].flexVolume +=== .spec.volumes[].flexVolume Description:: + -- @@ -6444,7 +6450,7 @@ Required:: | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |=== -..spec.volumes[].flexVolume.secretRef +=== .spec.volumes[].flexVolume.secretRef Description:: + -- @@ -6466,7 +6472,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].flocker +=== .spec.volumes[].flocker Description:: + -- @@ -6492,7 +6498,7 @@ Type:: | UUID of the dataset. This is unique identifier of a Flocker dataset |=== -..spec.volumes[].gcePersistentDisk +=== .spec.volumes[].gcePersistentDisk Description:: + -- @@ -6528,7 +6534,7 @@ Required:: | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |=== -..spec.volumes[].gitRepo +=== .spec.volumes[].gitRepo Description:: + -- @@ -6560,7 +6566,7 @@ Required:: | Commit hash for the specified revision. |=== -..spec.volumes[].glusterfs +=== .spec.volumes[].glusterfs Description:: + -- @@ -6593,7 +6599,7 @@ Required:: | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |=== -..spec.volumes[].hostPath +=== .spec.volumes[].hostPath Description:: + -- @@ -6621,7 +6627,7 @@ Required:: | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |=== -..spec.volumes[].iscsi +=== .spec.volumes[].iscsi Description:: + -- @@ -6687,7 +6693,7 @@ Required:: | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |=== -..spec.volumes[].iscsi.secretRef +=== .spec.volumes[].iscsi.secretRef Description:: + -- @@ -6709,7 +6715,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].nfs +=== .spec.volumes[].nfs Description:: + -- @@ -6742,7 +6748,7 @@ Required:: | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |=== -..spec.volumes[].persistentVolumeClaim +=== .spec.volumes[].persistentVolumeClaim Description:: + -- @@ -6770,7 +6776,7 @@ Required:: | Will force the ReadOnly setting in VolumeMounts. Default false. |=== -..spec.volumes[].photonPersistentDisk +=== .spec.volumes[].photonPersistentDisk Description:: + -- @@ -6798,7 +6804,7 @@ Required:: | ID that identifies Photon Controller persistent disk |=== -..spec.volumes[].portworxVolume +=== .spec.volumes[].portworxVolume Description:: + -- @@ -6830,7 +6836,7 @@ Required:: | VolumeID uniquely identifies a Portworx volume |=== -..spec.volumes[].projected +=== .spec.volumes[].projected Description:: + -- @@ -6862,7 +6868,7 @@ Required:: | Projection that may be projected along with other supported volume types |=== -..spec.volumes[].projected.sources +=== .spec.volumes[].projected.sources Description:: + -- @@ -6875,7 +6881,7 @@ Type:: -..spec.volumes[].projected.sources[] +=== .spec.volumes[].projected.sources[] Description:: + -- @@ -6909,7 +6915,7 @@ Type:: | information about the serviceAccountToken data to project |=== -..spec.volumes[].projected.sources[].configMap +=== .spec.volumes[].projected.sources[].configMap Description:: + -- @@ -6943,7 +6949,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].projected.sources[].configMap.items +=== .spec.volumes[].projected.sources[].configMap.items Description:: + -- @@ -6956,7 +6962,7 @@ Type:: -..spec.volumes[].projected.sources[].configMap.items[] +=== .spec.volumes[].projected.sources[].configMap.items[] Description:: + -- @@ -6989,7 +6995,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].downwardAPI +=== .spec.volumes[].projected.sources[].downwardAPI Description:: + -- @@ -7015,7 +7021,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].projected.sources[].downwardAPI.items +=== .spec.volumes[].projected.sources[].downwardAPI.items Description:: + -- @@ -7028,7 +7034,7 @@ Type:: -..spec.volumes[].projected.sources[].downwardAPI.items[] +=== .spec.volumes[].projected.sources[].downwardAPI.items[] Description:: + -- @@ -7064,7 +7070,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description:: + -- @@ -7092,7 +7098,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -7124,7 +7130,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].projected.sources[].secret +=== .spec.volumes[].projected.sources[].secret Description:: + -- @@ -7158,7 +7164,7 @@ Type:: | Specify whether the Secret or its key must be defined |=== -..spec.volumes[].projected.sources[].secret.items +=== .spec.volumes[].projected.sources[].secret.items Description:: + -- @@ -7171,7 +7177,7 @@ Type:: -..spec.volumes[].projected.sources[].secret.items[] +=== .spec.volumes[].projected.sources[].secret.items[] Description:: + -- @@ -7204,7 +7210,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].serviceAccountToken +=== .spec.volumes[].projected.sources[].serviceAccountToken Description:: + -- @@ -7236,7 +7242,7 @@ Required:: | Path is the path relative to the mount point of the file to project the token into. |=== -..spec.volumes[].quobyte +=== .spec.volumes[].quobyte Description:: + -- @@ -7281,7 +7287,7 @@ Required:: | Volume is a string that references an already created Quobyte volume by name. |=== -..spec.volumes[].rbd +=== .spec.volumes[].rbd Description:: + -- @@ -7334,7 +7340,7 @@ Required:: | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |=== -..spec.volumes[].rbd.secretRef +=== .spec.volumes[].rbd.secretRef Description:: + -- @@ -7356,7 +7362,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].scaleIO +=== .spec.volumes[].scaleIO Description:: + -- @@ -7418,7 +7424,7 @@ Required:: | The name of a volume already created in the ScaleIO system that is associated with this volume source. |=== -..spec.volumes[].scaleIO.secretRef +=== .spec.volumes[].scaleIO.secretRef Description:: + -- @@ -7440,7 +7446,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].secret +=== .spec.volumes[].secret Description:: + -- @@ -7478,7 +7484,7 @@ Type:: | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -..spec.volumes[].secret.items +=== .spec.volumes[].secret.items Description:: + -- @@ -7491,7 +7497,7 @@ Type:: -..spec.volumes[].secret.items[] +=== .spec.volumes[].secret.items[] Description:: + -- @@ -7524,7 +7530,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].storageos +=== .spec.volumes[].storageos Description:: + -- @@ -7562,7 +7568,7 @@ Type:: | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |=== -..spec.volumes[].storageos.secretRef +=== .spec.volumes[].storageos.secretRef Description:: + -- @@ -7584,7 +7590,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].vsphereVolume +=== .spec.volumes[].vsphereVolume Description:: + -- @@ -7620,7 +7626,7 @@ Required:: | Path that identifies vSphere volume vmdk |=== -..status +=== .status Description:: + -- @@ -7741,7 +7747,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#alertmanagerlist-monitoring-coreos-com-v1[`AlertmanagerList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.AlertmanagerList[`AlertmanagerList`] schema +| 401 - Unauthorized +| Empty |=== @@ -7819,7 +7827,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -7876,7 +7886,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#alertmanagerlist-monitoring-coreos-com-v1[`AlertmanagerList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.AlertmanagerList[`AlertmanagerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -7903,7 +7915,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema | |=== @@ -7912,7 +7924,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 201 - Created +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 202 - Accepted +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 401 - Unauthorized +| Empty |=== @@ -7969,7 +7987,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -7978,7 +7996,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8005,7 +8027,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8032,7 +8056,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -8041,7 +8065,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8068,7 +8094,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema | |=== @@ -8077,7 +8103,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager monitoring.coreos.com/v1`] +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 201 - Created +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`Alertmanager`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc b/rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc index 4cea125ed548..1e6f62196bb1 100644 --- a/rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc +++ b/rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="alertmanagerconfig-monitoring-coreos-com-v1alpha1"] = AlertmanagerConfig [monitoring.coreos.com/v1alpha1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the `namespace` label is equal to the namespace of the AlertmanagerConfig resource. |=== -..spec +=== .spec Description:: + -- @@ -81,7 +83,7 @@ Type:: | The Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route. |=== -..spec.inhibitRules +=== .spec.inhibitRules Description:: + -- @@ -94,7 +96,7 @@ Type:: -..spec.inhibitRules[] +=== .spec.inhibitRules[] Description:: + -- @@ -132,7 +134,7 @@ Type:: | Matcher defines how to match on alert's labels. |=== -..spec.inhibitRules[].sourceMatch +=== .spec.inhibitRules[].sourceMatch Description:: + -- @@ -145,7 +147,7 @@ Type:: -..spec.inhibitRules[].sourceMatch[] +=== .spec.inhibitRules[].sourceMatch[] Description:: + -- @@ -177,7 +179,7 @@ Required:: | Label value to match. |=== -..spec.inhibitRules[].targetMatch +=== .spec.inhibitRules[].targetMatch Description:: + -- @@ -190,7 +192,7 @@ Type:: -..spec.inhibitRules[].targetMatch[] +=== .spec.inhibitRules[].targetMatch[] Description:: + -- @@ -222,7 +224,7 @@ Required:: | Label value to match. |=== -..spec.receivers +=== .spec.receivers Description:: + -- @@ -235,7 +237,7 @@ Type:: -..spec.receivers[] +=== .spec.receivers[] Description:: + -- @@ -323,7 +325,7 @@ Required:: | WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config |=== -..spec.receivers[].emailConfigs +=== .spec.receivers[].emailConfigs Description:: + -- @@ -336,7 +338,7 @@ Type:: -..spec.receivers[].emailConfigs[] +=== .spec.receivers[].emailConfigs[] Description:: + -- @@ -414,7 +416,7 @@ Type:: | The email address to send notifications to. |=== -..spec.receivers[].emailConfigs[].authPassword +=== .spec.receivers[].emailConfigs[].authPassword Description:: + -- @@ -446,7 +448,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].emailConfigs[].authSecret +=== .spec.receivers[].emailConfigs[].authSecret Description:: + -- @@ -478,7 +480,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].emailConfigs[].headers +=== .spec.receivers[].emailConfigs[].headers Description:: + -- @@ -491,7 +493,7 @@ Type:: -..spec.receivers[].emailConfigs[].headers[] +=== .spec.receivers[].emailConfigs[].headers[] Description:: + -- @@ -520,7 +522,7 @@ Required:: | Value of the tuple. |=== -..spec.receivers[].emailConfigs[].tlsConfig +=== .spec.receivers[].emailConfigs[].tlsConfig Description:: + -- @@ -558,7 +560,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].emailConfigs[].tlsConfig.ca +=== .spec.receivers[].emailConfigs[].tlsConfig.ca Description:: + -- @@ -584,7 +586,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].emailConfigs[].tlsConfig.ca.configMap +=== .spec.receivers[].emailConfigs[].tlsConfig.ca.configMap Description:: + -- @@ -616,7 +618,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].emailConfigs[].tlsConfig.ca.secret +=== .spec.receivers[].emailConfigs[].tlsConfig.ca.secret Description:: + -- @@ -648,7 +650,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].emailConfigs[].tlsConfig.cert +=== .spec.receivers[].emailConfigs[].tlsConfig.cert Description:: + -- @@ -674,7 +676,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].emailConfigs[].tlsConfig.cert.configMap +=== .spec.receivers[].emailConfigs[].tlsConfig.cert.configMap Description:: + -- @@ -706,7 +708,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].emailConfigs[].tlsConfig.cert.secret +=== .spec.receivers[].emailConfigs[].tlsConfig.cert.secret Description:: + -- @@ -738,7 +740,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].emailConfigs[].tlsConfig.keySecret +=== .spec.receivers[].emailConfigs[].tlsConfig.keySecret Description:: + -- @@ -770,7 +772,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs +=== .spec.receivers[].opsgenieConfigs Description:: + -- @@ -783,7 +785,7 @@ Type:: -..spec.receivers[].opsgenieConfigs[] +=== .spec.receivers[].opsgenieConfigs[] Description:: + -- @@ -857,7 +859,7 @@ Type:: | Comma separated list of tags attached to the notifications. |=== -..spec.receivers[].opsgenieConfigs[].apiKey +=== .spec.receivers[].opsgenieConfigs[].apiKey Description:: + -- @@ -889,7 +891,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].details +=== .spec.receivers[].opsgenieConfigs[].details Description:: + -- @@ -902,7 +904,7 @@ Type:: -..spec.receivers[].opsgenieConfigs[].details[] +=== .spec.receivers[].opsgenieConfigs[].details[] Description:: + -- @@ -931,7 +933,7 @@ Required:: | Value of the tuple. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig +=== .spec.receivers[].opsgenieConfigs[].httpConfig Description:: + -- @@ -948,9 +950,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -965,11 +971,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth +=== .spec.receivers[].opsgenieConfigs[].httpConfig.authorization Description:: + -- -BasicAuth for the client. +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].opsgenieConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth +Description:: ++ +-- +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -991,7 +1055,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -1023,7 +1087,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -1055,7 +1119,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -1087,7 +1151,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig Description:: + -- @@ -1125,7 +1189,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -1151,7 +1215,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -1183,7 +1247,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -1215,7 +1279,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -1241,7 +1305,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -1273,7 +1337,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -1305,7 +1369,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -1337,7 +1401,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].opsgenieConfigs[].responders +=== .spec.receivers[].opsgenieConfigs[].responders Description:: + -- @@ -1350,7 +1414,7 @@ Type:: -..spec.receivers[].opsgenieConfigs[].responders[] +=== .spec.receivers[].opsgenieConfigs[].responders[] Description:: + -- @@ -1386,7 +1450,7 @@ Required:: | Username of the responder. |=== -..spec.receivers[].pagerdutyConfigs +=== .spec.receivers[].pagerdutyConfigs Description:: + -- @@ -1399,7 +1463,7 @@ Type:: -..spec.receivers[].pagerdutyConfigs[] +=== .spec.receivers[].pagerdutyConfigs[] Description:: + -- @@ -1473,7 +1537,7 @@ Type:: | The URL to send requests to. |=== -..spec.receivers[].pagerdutyConfigs[].details +=== .spec.receivers[].pagerdutyConfigs[].details Description:: + -- @@ -1486,7 +1550,7 @@ Type:: -..spec.receivers[].pagerdutyConfigs[].details[] +=== .spec.receivers[].pagerdutyConfigs[].details[] Description:: + -- @@ -1515,7 +1579,7 @@ Required:: | Value of the tuple. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig +=== .spec.receivers[].pagerdutyConfigs[].httpConfig Description:: + -- @@ -1532,9 +1596,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -1549,11 +1617,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization +Description:: ++ +-- +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth Description:: + -- -BasicAuth for the client. +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -1575,7 +1701,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -1607,7 +1733,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -1639,7 +1765,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -1671,7 +1797,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig Description:: + -- @@ -1709,7 +1835,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -1735,7 +1861,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -1767,7 +1893,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -1799,7 +1925,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -1825,7 +1951,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -1857,7 +1983,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -1889,7 +2015,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -1921,7 +2047,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].routingKey +=== .spec.receivers[].pagerdutyConfigs[].routingKey Description:: + -- @@ -1953,7 +2079,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pagerdutyConfigs[].serviceKey +=== .spec.receivers[].pagerdutyConfigs[].serviceKey Description:: + -- @@ -1985,7 +2111,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs +=== .spec.receivers[].pushoverConfigs Description:: + -- @@ -1998,7 +2124,7 @@ Type:: -..spec.receivers[].pushoverConfigs[] +=== .spec.receivers[].pushoverConfigs[] Description:: + -- @@ -2068,7 +2194,7 @@ Type:: | The secret's key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |=== -..spec.receivers[].pushoverConfigs[].httpConfig +=== .spec.receivers[].pushoverConfigs[].httpConfig Description:: + -- @@ -2085,9 +2211,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -2102,11 +2232,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].pushoverConfigs[].httpConfig.basicAuth +=== .spec.receivers[].pushoverConfigs[].httpConfig.authorization Description:: + -- -BasicAuth for the client. +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].pushoverConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth +Description:: ++ +-- +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -2128,7 +2316,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -2160,7 +2348,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -2192,7 +2380,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].pushoverConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -2224,7 +2412,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig Description:: + -- @@ -2262,7 +2450,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -2288,7 +2476,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -2320,7 +2508,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -2352,7 +2540,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -2378,7 +2566,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -2410,7 +2598,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -2442,7 +2630,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -2474,7 +2662,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].token +=== .spec.receivers[].pushoverConfigs[].token Description:: + -- @@ -2506,7 +2694,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].pushoverConfigs[].userKey +=== .spec.receivers[].pushoverConfigs[].userKey Description:: + -- @@ -2538,7 +2726,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs +=== .spec.receivers[].slackConfigs Description:: + -- @@ -2551,7 +2739,7 @@ Type:: -..spec.receivers[].slackConfigs[] +=== .spec.receivers[].slackConfigs[] Description:: + -- @@ -2665,7 +2853,7 @@ Type:: | |=== -..spec.receivers[].slackConfigs[].actions +=== .spec.receivers[].slackConfigs[].actions Description:: + -- @@ -2678,7 +2866,7 @@ Type:: -..spec.receivers[].slackConfigs[].actions[] +=== .spec.receivers[].slackConfigs[].actions[] Description:: + -- @@ -2727,7 +2915,7 @@ Required:: | |=== -..spec.receivers[].slackConfigs[].actions[].confirm +=== .spec.receivers[].slackConfigs[].actions[].confirm Description:: + -- @@ -2763,7 +2951,7 @@ Required:: | |=== -..spec.receivers[].slackConfigs[].apiURL +=== .spec.receivers[].slackConfigs[].apiURL Description:: + -- @@ -2795,7 +2983,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].fields +=== .spec.receivers[].slackConfigs[].fields Description:: + -- @@ -2808,7 +2996,7 @@ Type:: -..spec.receivers[].slackConfigs[].fields[] +=== .spec.receivers[].slackConfigs[].fields[] Description:: + -- @@ -2841,7 +3029,7 @@ Required:: | |=== -..spec.receivers[].slackConfigs[].httpConfig +=== .spec.receivers[].slackConfigs[].httpConfig Description:: + -- @@ -2858,9 +3046,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -2875,11 +3067,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].slackConfigs[].httpConfig.basicAuth +=== .spec.receivers[].slackConfigs[].httpConfig.authorization +Description:: ++ +-- +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].slackConfigs[].httpConfig.authorization.credentials Description:: + -- -BasicAuth for the client. +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].slackConfigs[].httpConfig.basicAuth +Description:: ++ +-- +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -2901,7 +3151,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].slackConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].slackConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -2933,7 +3183,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].slackConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -2965,7 +3215,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].slackConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -2997,7 +3247,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig Description:: + -- @@ -3035,7 +3285,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -3061,7 +3311,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -3093,7 +3343,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -3125,7 +3375,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -3151,7 +3401,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -3183,7 +3433,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -3215,7 +3465,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].slackConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].slackConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -3247,7 +3497,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs +=== .spec.receivers[].victoropsConfigs Description:: + -- @@ -3260,7 +3510,7 @@ Type:: -..spec.receivers[].victoropsConfigs[] +=== .spec.receivers[].victoropsConfigs[] Description:: + -- @@ -3322,7 +3572,7 @@ Type:: | Contains long explanation of the alerted problem. |=== -..spec.receivers[].victoropsConfigs[].apiKey +=== .spec.receivers[].victoropsConfigs[].apiKey Description:: + -- @@ -3354,7 +3604,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].customFields +=== .spec.receivers[].victoropsConfigs[].customFields Description:: + -- @@ -3367,7 +3617,7 @@ Type:: -..spec.receivers[].victoropsConfigs[].customFields[] +=== .spec.receivers[].victoropsConfigs[].customFields[] Description:: + -- @@ -3396,7 +3646,7 @@ Required:: | Value of the tuple. |=== -..spec.receivers[].victoropsConfigs[].httpConfig +=== .spec.receivers[].victoropsConfigs[].httpConfig Description:: + -- @@ -3413,9 +3663,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -3430,11 +3684,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].victoropsConfigs[].httpConfig.basicAuth +=== .spec.receivers[].victoropsConfigs[].httpConfig.authorization Description:: + -- -BasicAuth for the client. +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].victoropsConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth +Description:: ++ +-- +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -3456,7 +3768,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -3488,7 +3800,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -3520,7 +3832,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -3552,7 +3864,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig Description:: + -- @@ -3590,7 +3902,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -3616,7 +3928,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -3648,7 +3960,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -3680,7 +3992,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -3706,7 +4018,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -3738,7 +4050,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -3770,7 +4082,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -3802,7 +4114,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs +=== .spec.receivers[].webhookConfigs Description:: + -- @@ -3815,7 +4127,7 @@ Type:: -..spec.receivers[].webhookConfigs[] +=== .spec.receivers[].webhookConfigs[] Description:: + -- @@ -3853,7 +4165,7 @@ Type:: | The secret's key that contains the webhook URL to send HTTP requests to. `urlSecret` takes precedence over `url`. One of `urlSecret` and `url` should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. |=== -..spec.receivers[].webhookConfigs[].httpConfig +=== .spec.receivers[].webhookConfigs[].httpConfig Description:: + -- @@ -3870,9 +4182,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -3887,11 +4203,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].webhookConfigs[].httpConfig.basicAuth +=== .spec.receivers[].webhookConfigs[].httpConfig.authorization Description:: + -- -BasicAuth for the client. +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].webhookConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].webhookConfigs[].httpConfig.basicAuth +Description:: ++ +-- +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -3913,7 +4287,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -3945,7 +4319,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -3977,7 +4351,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -4009,7 +4383,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig Description:: + -- @@ -4047,7 +4421,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -4073,7 +4447,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -4105,7 +4479,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -4137,7 +4511,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -4163,7 +4537,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -4195,7 +4569,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -4227,7 +4601,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -4259,7 +4633,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].webhookConfigs[].urlSecret +=== .spec.receivers[].webhookConfigs[].urlSecret Description:: + -- @@ -4291,7 +4665,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs +=== .spec.receivers[].wechatConfigs Description:: + -- @@ -4304,7 +4678,7 @@ Type:: -..spec.receivers[].wechatConfigs[] +=== .spec.receivers[].wechatConfigs[] Description:: + -- @@ -4366,7 +4740,7 @@ Type:: | |=== -..spec.receivers[].wechatConfigs[].apiSecret +=== .spec.receivers[].wechatConfigs[].apiSecret Description:: + -- @@ -4398,7 +4772,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig +=== .spec.receivers[].wechatConfigs[].httpConfig Description:: + -- @@ -4415,9 +4789,13 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + | `basicAuth` | `object` -| BasicAuth for the client. +| BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. | `bearerTokenSecret` | `object` @@ -4432,11 +4810,69 @@ Type:: | TLS configuration for the client. |=== -..spec.receivers[].wechatConfigs[].httpConfig.basicAuth +=== .spec.receivers[].wechatConfigs[].httpConfig.authorization +Description:: ++ +-- +Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.receivers[].wechatConfigs[].httpConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.receivers[].wechatConfigs[].httpConfig.basicAuth Description:: + -- -BasicAuth for the client. +BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. -- Type:: @@ -4458,7 +4894,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password +=== .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password Description:: + -- @@ -4490,7 +4926,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username +=== .spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username Description:: + -- @@ -4522,7 +4958,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret +=== .spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret Description:: + -- @@ -4554,7 +4990,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig Description:: + -- @@ -4592,7 +5028,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca Description:: + -- @@ -4618,7 +5054,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap Description:: + -- @@ -4650,7 +5086,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret Description:: + -- @@ -4682,7 +5118,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert Description:: + -- @@ -4708,7 +5144,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap Description:: + -- @@ -4740,7 +5176,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret Description:: + -- @@ -4772,7 +5208,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret +=== .spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret Description:: + -- @@ -4804,7 +5240,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.route +=== .spec.route Description:: + -- @@ -4858,7 +5294,7 @@ Type:: | Child routes. |=== -..spec.route.matchers +=== .spec.route.matchers Description:: + -- @@ -4871,7 +5307,7 @@ Type:: -..spec.route.matchers[] +=== .spec.route.matchers[] Description:: + -- @@ -4980,7 +5416,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#alertmanagerconfiglist-monitoring-coreos-com-v1alpha1[`AlertmanagerConfigList monitoring.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1alpha1.AlertmanagerConfigList[`AlertmanagerConfigList`] schema +| 401 - Unauthorized +| Empty |=== @@ -5058,7 +5496,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -5115,7 +5555,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#alertmanagerconfiglist-monitoring-coreos-com-v1alpha1[`AlertmanagerConfigList monitoring.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1alpha1.AlertmanagerConfigList[`AlertmanagerConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -5142,7 +5584,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema | |=== @@ -5151,7 +5593,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 201 - Created +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 202 - Accepted +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 401 - Unauthorized +| Empty |=== @@ -5208,7 +5656,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -5217,7 +5665,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -5244,7 +5696,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -5271,7 +5725,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -5280,7 +5734,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -5307,7 +5763,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema | |=== @@ -5316,7 +5772,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig monitoring.coreos.com/v1alpha1`] +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 201 - Created +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`AlertmanagerConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/monitoring-apis-index.adoc b/rest_api/monitoring_apis/monitoring-apis-index.adoc index bbaf88e1a827..02de351f5537 100644 --- a/rest_api/monitoring_apis/monitoring-apis-index.adoc +++ b/rest_api/monitoring_apis/monitoring-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="monitoring-apis"] = Monitoring APIs ifdef::product-title[] diff --git a/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc index 5b865183f252..e709bc3a5b7d 100644 --- a/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="podmonitor-monitoring-coreos-com-v1"] = PodMonitor [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | Specification of desired Pod selection for target discovery by Prometheus. |=== -..spec +=== .spec Description:: + -- @@ -67,6 +69,18 @@ Required:: | `string` | The label to use to retrieve the job name from. +| `labelLimit` +| `integer` +| Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelNameLengthLimit` +| `integer` +| Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelValueLengthLimit` +| `integer` +| Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + | `namespaceSelector` | `object` | Selector to select which namespaces the Endpoints objects are discovered from. @@ -96,7 +110,7 @@ Required:: | TargetLimit defines a limit on the number of scraped targets that will be accepted. |=== -..spec.namespaceSelector +=== .spec.namespaceSelector Description:: + -- @@ -122,7 +136,7 @@ Type:: | List of namespace names. |=== -..spec.podMetricsEndpoints +=== .spec.podMetricsEndpoints Description:: + -- @@ -135,7 +149,7 @@ Type:: -..spec.podMetricsEndpoints[] +=== .spec.podMetricsEndpoints[] Description:: + -- @@ -152,6 +166,10 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization section for this endpoint + | `basicAuth` | `object` | BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint @@ -180,6 +198,10 @@ Type:: | `object` | RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs +| `oauth2` +| `object` +| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + | `params` | `object` | Optional HTTP URL parameters @@ -225,7 +247,65 @@ Type:: | TLS configuration to use when scraping the endpoint. |=== -..spec.podMetricsEndpoints[].basicAuth +=== .spec.podMetricsEndpoints[].authorization +Description:: ++ +-- +Authorization section for this endpoint +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.podMetricsEndpoints[].authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.podMetricsEndpoints[].basicAuth Description:: + -- @@ -251,7 +331,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.podMetricsEndpoints[].basicAuth.password +=== .spec.podMetricsEndpoints[].basicAuth.password Description:: + -- @@ -283,7 +363,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetricsEndpoints[].basicAuth.username +=== .spec.podMetricsEndpoints[].basicAuth.username Description:: + -- @@ -315,7 +395,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetricsEndpoints[].bearerTokenSecret +=== .spec.podMetricsEndpoints[].bearerTokenSecret Description:: + -- @@ -347,7 +427,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetricsEndpoints[].metricRelabelings +=== .spec.podMetricsEndpoints[].metricRelabelings Description:: + -- @@ -360,7 +440,7 @@ Type:: -..spec.podMetricsEndpoints[].metricRelabelings[] +=== .spec.podMetricsEndpoints[].metricRelabelings[] Description:: + -- @@ -406,7 +486,171 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.podMetricsEndpoints[].params +=== .spec.podMetricsEndpoints[].oauth2 +Description:: ++ +-- +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. +-- + +Type:: + `object` + +Required:: + - `clientId` + - `clientSecret` + - `tokenUrl` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `clientId` +| `object` +| The secret or configmap containing the OAuth2 client id + +| `clientSecret` +| `object` +| The secret containing the OAuth2 client secret + +| `endpointParams` +| `object (string)` +| Parameters to append to the token URL + +| `scopes` +| `array (string)` +| OAuth2 scopes used for the token request + +| `tokenUrl` +| `string` +| The URL to fetch the token from + +|=== +=== .spec.podMetricsEndpoints[].oauth2.clientId +Description:: ++ +-- +The secret or configmap containing the OAuth2 client id +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.podMetricsEndpoints[].oauth2.clientId.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.podMetricsEndpoints[].oauth2.clientId.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.podMetricsEndpoints[].oauth2.clientSecret +Description:: ++ +-- +The secret containing the OAuth2 client secret +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.podMetricsEndpoints[].params Description:: + -- @@ -419,7 +663,7 @@ Type:: -..spec.podMetricsEndpoints[].relabelings +=== .spec.podMetricsEndpoints[].relabelings Description:: + -- @@ -432,7 +676,7 @@ Type:: -..spec.podMetricsEndpoints[].relabelings[] +=== .spec.podMetricsEndpoints[].relabelings[] Description:: + -- @@ -478,7 +722,7 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.podMetricsEndpoints[].tlsConfig +=== .spec.podMetricsEndpoints[].tlsConfig Description:: + -- @@ -516,7 +760,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.podMetricsEndpoints[].tlsConfig.ca +=== .spec.podMetricsEndpoints[].tlsConfig.ca Description:: + -- @@ -542,7 +786,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.podMetricsEndpoints[].tlsConfig.ca.configMap +=== .spec.podMetricsEndpoints[].tlsConfig.ca.configMap Description:: + -- @@ -574,7 +818,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.podMetricsEndpoints[].tlsConfig.ca.secret +=== .spec.podMetricsEndpoints[].tlsConfig.ca.secret Description:: + -- @@ -606,7 +850,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetricsEndpoints[].tlsConfig.cert +=== .spec.podMetricsEndpoints[].tlsConfig.cert Description:: + -- @@ -632,7 +876,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.podMetricsEndpoints[].tlsConfig.cert.configMap +=== .spec.podMetricsEndpoints[].tlsConfig.cert.configMap Description:: + -- @@ -664,7 +908,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.podMetricsEndpoints[].tlsConfig.cert.secret +=== .spec.podMetricsEndpoints[].tlsConfig.cert.secret Description:: + -- @@ -696,7 +940,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetricsEndpoints[].tlsConfig.keySecret +=== .spec.podMetricsEndpoints[].tlsConfig.keySecret Description:: + -- @@ -728,7 +972,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -758,7 +1002,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -771,7 +1015,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -881,7 +1125,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#podmonitorlist-monitoring-coreos-com-v1[`PodMonitorList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PodMonitorList[`PodMonitorList`] schema +| 401 - Unauthorized +| Empty |=== @@ -959,7 +1205,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1016,7 +1264,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#podmonitorlist-monitoring-coreos-com-v1[`PodMonitorList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PodMonitorList[`PodMonitorList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1043,7 +1293,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema | |=== @@ -1052,7 +1302,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 201 - Created +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 202 - Accepted +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 401 - Unauthorized +| Empty |=== @@ -1109,7 +1365,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1118,7 +1374,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1145,7 +1405,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1172,7 +1434,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1181,7 +1443,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1208,7 +1472,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema | |=== @@ -1217,7 +1481,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 201 - Created +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`PodMonitor`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc index fd3e5f89c075..4b5770eed78d 100644 --- a/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="probe-monitoring-coreos-com-v1"] = Probe [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | Specification of desired Ingress selection for target discovery by Prometheus. |=== -..spec +=== .spec Description:: + -- @@ -60,6 +62,10 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization section for this endpoint + | `basicAuth` | `object` | BasicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint @@ -76,18 +82,50 @@ Type:: | `string` | The job name assigned to scraped metrics by default. +| `labelLimit` +| `integer` +| Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelNameLengthLimit` +| `integer` +| Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelValueLengthLimit` +| `integer` +| Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `metricRelabelings` +| `array` +| MetricRelabelConfigs to apply to samples before ingestion. + +| `metricRelabelings[]` +| `object` +| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs + | `module` | `string` | The module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml +| `oauth2` +| `object` +| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + | `prober` | `object` | Specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty. +| `sampleLimit` +| `integer` +| SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + | `scrapeTimeout` | `string` | Timeout for scraping metrics from the Prometheus exporter. +| `targetLimit` +| `integer` +| TargetLimit defines a limit on the number of scraped targets that will be accepted. + | `targets` | `object` | Targets defines a set of static and/or dynamically discovered targets to be probed using the prober. @@ -97,7 +135,65 @@ Type:: | TLS configuration to use when scraping the endpoint. |=== -..spec.basicAuth +=== .spec.authorization +Description:: ++ +-- +Authorization section for this endpoint +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.basicAuth Description:: + -- @@ -123,7 +219,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.basicAuth.password +=== .spec.basicAuth.password Description:: + -- @@ -155,7 +251,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.basicAuth.username +=== .spec.basicAuth.username Description:: + -- @@ -187,7 +283,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.bearerTokenSecret +=== .spec.bearerTokenSecret Description:: + -- @@ -219,7 +315,230 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.prober +=== .spec.metricRelabelings +Description:: ++ +-- +MetricRelabelConfigs to apply to samples before ingestion. +-- + +Type:: + `array` + + + + +=== .spec.metricRelabelings[] +Description:: ++ +-- +RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `action` +| `string` +| Action to perform based on regex matching. Default is 'replace' + +| `modulus` +| `integer` +| Modulus to take of the hash of the source label values. + +| `regex` +| `string` +| Regular expression against which the extracted value is matched. Default is '(.*)' + +| `replacement` +| `string` +| Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1' + +| `separator` +| `string` +| Separator placed between concatenated source label values. default is ';'. + +| `sourceLabels` +| `array (string)` +| The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. + +| `targetLabel` +| `string` +| Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. + +|=== +=== .spec.oauth2 +Description:: ++ +-- +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. +-- + +Type:: + `object` + +Required:: + - `clientId` + - `clientSecret` + - `tokenUrl` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `clientId` +| `object` +| The secret or configmap containing the OAuth2 client id + +| `clientSecret` +| `object` +| The secret containing the OAuth2 client secret + +| `endpointParams` +| `object (string)` +| Parameters to append to the token URL + +| `scopes` +| `array (string)` +| OAuth2 scopes used for the token request + +| `tokenUrl` +| `string` +| The URL to fetch the token from + +|=== +=== .spec.oauth2.clientId +Description:: ++ +-- +The secret or configmap containing the OAuth2 client id +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.oauth2.clientId.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.oauth2.clientId.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.oauth2.clientSecret +Description:: ++ +-- +The secret containing the OAuth2 client secret +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.prober Description:: + -- @@ -255,7 +574,7 @@ Required:: | Mandatory URL of the prober. |=== -..spec.targets +=== .spec.targets Description:: + -- @@ -281,7 +600,7 @@ Type:: | StaticConfig defines static targets which are considers for probing. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config. |=== -..spec.targets.ingress +=== .spec.targets.ingress Description:: + -- @@ -315,7 +634,7 @@ Type:: | Select Ingress objects by labels. |=== -..spec.targets.ingress.namespaceSelector +=== .spec.targets.ingress.namespaceSelector Description:: + -- @@ -341,7 +660,7 @@ Type:: | List of namespace names. |=== -..spec.targets.ingress.relabelingConfigs +=== .spec.targets.ingress.relabelingConfigs Description:: + -- @@ -354,7 +673,7 @@ Type:: -..spec.targets.ingress.relabelingConfigs[] +=== .spec.targets.ingress.relabelingConfigs[] Description:: + -- @@ -400,7 +719,7 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.targets.ingress.selector +=== .spec.targets.ingress.selector Description:: + -- @@ -430,7 +749,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.targets.ingress.selector.matchExpressions +=== .spec.targets.ingress.selector.matchExpressions Description:: + -- @@ -443,7 +762,7 @@ Type:: -..spec.targets.ingress.selector.matchExpressions[] +=== .spec.targets.ingress.selector.matchExpressions[] Description:: + -- @@ -476,7 +795,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.targets.staticConfig +=== .spec.targets.staticConfig Description:: + -- @@ -510,7 +829,7 @@ Type:: | Targets is a list of URLs to probe using the configured prober. |=== -..spec.targets.staticConfig.relabelingConfigs +=== .spec.targets.staticConfig.relabelingConfigs Description:: + -- @@ -523,7 +842,7 @@ Type:: -..spec.targets.staticConfig.relabelingConfigs[] +=== .spec.targets.staticConfig.relabelingConfigs[] Description:: + -- @@ -569,7 +888,7 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.tlsConfig +=== .spec.tlsConfig Description:: + -- @@ -607,7 +926,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.tlsConfig.ca +=== .spec.tlsConfig.ca Description:: + -- @@ -633,7 +952,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.tlsConfig.ca.configMap +=== .spec.tlsConfig.ca.configMap Description:: + -- @@ -665,7 +984,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.tlsConfig.ca.secret +=== .spec.tlsConfig.ca.secret Description:: + -- @@ -697,7 +1016,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.tlsConfig.cert +=== .spec.tlsConfig.cert Description:: + -- @@ -723,7 +1042,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.tlsConfig.cert.configMap +=== .spec.tlsConfig.cert.configMap Description:: + -- @@ -755,7 +1074,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.tlsConfig.cert.secret +=== .spec.tlsConfig.cert.secret Description:: + -- @@ -787,7 +1106,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.tlsConfig.keySecret +=== .spec.tlsConfig.keySecret Description:: + -- @@ -896,7 +1215,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#probelist-monitoring-coreos-com-v1[`ProbeList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ProbeList[`ProbeList`] schema +| 401 - Unauthorized +| Empty |=== @@ -974,7 +1295,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1031,7 +1354,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#probelist-monitoring-coreos-com-v1[`ProbeList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ProbeList[`ProbeList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1058,7 +1383,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema | |=== @@ -1067,7 +1392,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 201 - Created +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 202 - Accepted +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 401 - Unauthorized +| Empty |=== @@ -1124,7 +1455,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1133,7 +1464,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1160,7 +1495,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1187,7 +1524,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1196,7 +1533,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1223,7 +1562,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema | |=== @@ -1232,7 +1571,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe monitoring.coreos.com/v1`] +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 201 - Created +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`Probe`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc index 580760f4efcd..35e71bbd0573 100644 --- a/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="prometheus-monitoring-coreos-com-v1"] = Prometheus [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | Most recent observed status of the Prometheus cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -..spec +=== .spec Description:: + -- @@ -124,6 +126,22 @@ Type:: | `array (string)` | Enable access to Prometheus disabled features. By default, no features are enabled. Enabling disabled features is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. For more information see https://prometheus.io/docs/prometheus/latest/disabled_features/ +| `enforcedBodySizeLimit` +| `string` +| EnforcedBodySizeLimit defines the maximum size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. Example: 100MB. If defined, the limit will apply to all service/pod monitors and probes. This is an experimental feature, this behaviour could change or be removed in the future. Only valid in Prometheus versions 2.28.0 and newer. + +| `enforcedLabelLimit` +| `integer` +| Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer. + +| `enforcedLabelNameLengthLimit` +| `integer` +| Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer. + +| `enforcedLabelValueLengthLimit` +| `integer` +| Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit. Only valid in Prometheus versions 2.27.0 and newer. + | `enforcedNamespaceLabel` | `string` | EnforcedNamespaceLabel If set, a label will be added to @@ -136,7 +154,7 @@ Type:: | `enforcedTargetLimit` | `integer` -| EnforcedTargetLimit defines a global limit on the number of scraped targets. This overrides any TargetLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the TargetLimit to keep overall number of targets under the desired limit. Note that if TargetLimit is higher that value will be taken instead. +| EnforcedTargetLimit defines a global limit on the number of scraped targets. This overrides any TargetLimit set per ServiceMonitor or/and PodMonitor. It is meant to be used by admins to enforce the TargetLimit to keep the overall number of targets under the desired limit. Note that if TargetLimit is lower, that value will be taken instead, except if either value is zero, in which case the non-zero value will be used. If both values are zero, no limit is enforced. | `evaluationInterval` | `string` @@ -186,6 +204,10 @@ Type:: | `string` | Log level for Prometheus to be configured with. +| `minReadySeconds` +| `integer` +| Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. + | `nodeSelector` | `object (string)` | Define which Nodes the Pods are scheduled on. @@ -397,7 +419,7 @@ Type:: | WebSpec defines the web command line flags when starting Prometheus. |=== -..spec.additionalAlertManagerConfigs +=== .spec.additionalAlertManagerConfigs Description:: + -- @@ -429,7 +451,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.additionalAlertRelabelConfigs +=== .spec.additionalAlertRelabelConfigs Description:: + -- @@ -461,7 +483,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.additionalScrapeConfigs +=== .spec.additionalScrapeConfigs Description:: + -- @@ -493,7 +515,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.affinity +=== .spec.affinity Description:: + -- @@ -523,7 +545,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.affinity.nodeAffinity +=== .spec.affinity.nodeAffinity Description:: + -- @@ -553,7 +575,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -566,7 +588,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -595,7 +617,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -629,7 +651,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -642,7 +664,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -675,7 +697,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -688,7 +710,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -721,7 +743,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -749,7 +771,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -762,7 +784,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -796,7 +818,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -809,7 +831,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -842,7 +864,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -855,7 +877,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -888,7 +910,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity +=== .spec.affinity.podAffinity Description:: + -- @@ -922,7 +944,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -935,7 +957,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -964,7 +986,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -996,7 +1018,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1026,7 +1048,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1039,7 +1061,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1072,7 +1094,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1085,7 +1107,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1117,7 +1139,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1147,7 +1169,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1160,7 +1182,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1193,7 +1215,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity +=== .spec.affinity.podAntiAffinity Description:: + -- @@ -1227,7 +1249,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1240,7 +1262,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1269,7 +1291,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -1301,7 +1323,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1331,7 +1353,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1344,7 +1366,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1377,7 +1399,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1390,7 +1412,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1422,7 +1444,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1452,7 +1474,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1465,7 +1487,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1498,7 +1520,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.alerting +=== .spec.alerting Description:: + -- @@ -1526,7 +1548,7 @@ Required:: | AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against. |=== -..spec.alerting.alertmanagers +=== .spec.alerting.alertmanagers Description:: + -- @@ -1539,7 +1561,7 @@ Type:: -..spec.alerting.alertmanagers[] +=== .spec.alerting.alertmanagers[] Description:: + -- @@ -1564,6 +1586,10 @@ Required:: | `string` | Version of the Alertmanager API that Prometheus uses to send alerts. It can be "v1" or "v2". +| `authorization` +| `object` +| Authorization section for this alertmanager endpoint + | `bearerTokenFile` | `string` | BearerTokenFile to read from filesystem to use when authenticating to Alertmanager. @@ -1597,7 +1623,65 @@ Required:: | TLS Config to use for alertmanager connection. |=== -..spec.alerting.alertmanagers[].tlsConfig +=== .spec.alerting.alertmanagers[].authorization +Description:: ++ +-- +Authorization section for this alertmanager endpoint +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.alerting.alertmanagers[].authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.alerting.alertmanagers[].tlsConfig Description:: + -- @@ -1647,7 +1731,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.alerting.alertmanagers[].tlsConfig.ca +=== .spec.alerting.alertmanagers[].tlsConfig.ca Description:: + -- @@ -1673,7 +1757,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.alerting.alertmanagers[].tlsConfig.ca.configMap +=== .spec.alerting.alertmanagers[].tlsConfig.ca.configMap Description:: + -- @@ -1705,7 +1789,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.alerting.alertmanagers[].tlsConfig.ca.secret +=== .spec.alerting.alertmanagers[].tlsConfig.ca.secret Description:: + -- @@ -1737,7 +1821,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.alerting.alertmanagers[].tlsConfig.cert +=== .spec.alerting.alertmanagers[].tlsConfig.cert Description:: + -- @@ -1763,7 +1847,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.alerting.alertmanagers[].tlsConfig.cert.configMap +=== .spec.alerting.alertmanagers[].tlsConfig.cert.configMap Description:: + -- @@ -1795,7 +1879,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.alerting.alertmanagers[].tlsConfig.cert.secret +=== .spec.alerting.alertmanagers[].tlsConfig.cert.secret Description:: + -- @@ -1827,7 +1911,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.alerting.alertmanagers[].tlsConfig.keySecret +=== .spec.alerting.alertmanagers[].tlsConfig.keySecret Description:: + -- @@ -1859,7 +1943,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.apiserverConfig +=== .spec.apiserverConfig Description:: + -- @@ -1878,6 +1962,10 @@ Required:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization section for accessing apiserver + | `basicAuth` | `object` | BasicAuth allow an endpoint to authenticate over basic authentication @@ -1899,7 +1987,69 @@ Required:: | TLS Config to use for accessing apiserver. |=== -..spec.apiserverConfig.basicAuth +=== .spec.apiserverConfig.authorization +Description:: ++ +-- +Authorization section for accessing apiserver +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `credentialsFile` +| `string` +| File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization) + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.apiserverConfig.authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.apiserverConfig.basicAuth Description:: + -- @@ -1925,7 +2075,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.apiserverConfig.basicAuth.password +=== .spec.apiserverConfig.basicAuth.password Description:: + -- @@ -1957,7 +2107,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.apiserverConfig.basicAuth.username +=== .spec.apiserverConfig.basicAuth.username Description:: + -- @@ -1989,7 +2139,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.apiserverConfig.tlsConfig +=== .spec.apiserverConfig.tlsConfig Description:: + -- @@ -2039,7 +2189,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.apiserverConfig.tlsConfig.ca +=== .spec.apiserverConfig.tlsConfig.ca Description:: + -- @@ -2065,7 +2215,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.apiserverConfig.tlsConfig.ca.configMap +=== .spec.apiserverConfig.tlsConfig.ca.configMap Description:: + -- @@ -2097,7 +2247,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.apiserverConfig.tlsConfig.ca.secret +=== .spec.apiserverConfig.tlsConfig.ca.secret Description:: + -- @@ -2129,7 +2279,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.apiserverConfig.tlsConfig.cert +=== .spec.apiserverConfig.tlsConfig.cert Description:: + -- @@ -2155,7 +2305,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.apiserverConfig.tlsConfig.cert.configMap +=== .spec.apiserverConfig.tlsConfig.cert.configMap Description:: + -- @@ -2187,7 +2337,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.apiserverConfig.tlsConfig.cert.secret +=== .spec.apiserverConfig.tlsConfig.cert.secret Description:: + -- @@ -2219,7 +2369,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.apiserverConfig.tlsConfig.keySecret +=== .spec.apiserverConfig.tlsConfig.keySecret Description:: + -- @@ -2251,7 +2401,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.arbitraryFSAccessThroughSMs +=== .spec.arbitraryFSAccessThroughSMs Description:: + -- @@ -2273,7 +2423,7 @@ Type:: | |=== -..spec.containers +=== .spec.containers Description:: + -- @@ -2286,7 +2436,7 @@ Type:: -..spec.containers[] +=== .spec.containers[] Description:: + -- @@ -2414,7 +2564,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.containers[].env +=== .spec.containers[].env Description:: + -- @@ -2427,7 +2577,7 @@ Type:: -..spec.containers[].env[] +=== .spec.containers[].env[] Description:: + -- @@ -2459,7 +2609,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.containers[].env[].valueFrom +=== .spec.containers[].env[].valueFrom Description:: + -- @@ -2493,7 +2643,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.containers[].env[].valueFrom.configMapKeyRef +=== .spec.containers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -2525,7 +2675,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.containers[].env[].valueFrom.fieldRef +=== .spec.containers[].env[].valueFrom.fieldRef Description:: + -- @@ -2553,7 +2703,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.containers[].env[].valueFrom.resourceFieldRef +=== .spec.containers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -2585,7 +2735,7 @@ Required:: | Required: resource to select |=== -..spec.containers[].env[].valueFrom.secretKeyRef +=== .spec.containers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -2617,7 +2767,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.containers[].envFrom +=== .spec.containers[].envFrom Description:: + -- @@ -2630,7 +2780,7 @@ Type:: -..spec.containers[].envFrom[] +=== .spec.containers[].envFrom[] Description:: + -- @@ -2660,7 +2810,7 @@ Type:: | The Secret to select from |=== -..spec.containers[].envFrom[].configMapRef +=== .spec.containers[].envFrom[].configMapRef Description:: + -- @@ -2686,7 +2836,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.containers[].envFrom[].secretRef +=== .spec.containers[].envFrom[].secretRef Description:: + -- @@ -2712,7 +2862,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.containers[].lifecycle +=== .spec.containers[].lifecycle Description:: + -- @@ -2738,7 +2888,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.containers[].lifecycle.postStart +=== .spec.containers[].lifecycle.postStart Description:: + -- @@ -2768,7 +2918,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.postStart.exec +=== .spec.containers[].lifecycle.postStart.exec Description:: + -- @@ -2790,7 +2940,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.postStart.httpGet +=== .spec.containers[].lifecycle.postStart.httpGet Description:: + -- @@ -2834,7 +2984,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -2847,7 +2997,7 @@ Type:: -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -2876,7 +3026,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.postStart.tcpSocket +=== .spec.containers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -2904,7 +3054,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].lifecycle.preStop +=== .spec.containers[].lifecycle.preStop Description:: + -- @@ -2934,7 +3084,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.preStop.exec +=== .spec.containers[].lifecycle.preStop.exec Description:: + -- @@ -2956,7 +3106,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.preStop.httpGet +=== .spec.containers[].lifecycle.preStop.httpGet Description:: + -- @@ -3000,7 +3150,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -3013,7 +3163,7 @@ Type:: -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -3042,7 +3192,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.preStop.tcpSocket +=== .spec.containers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -3070,7 +3220,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].livenessProbe +=== .spec.containers[].livenessProbe Description:: + -- @@ -3120,7 +3270,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].livenessProbe.exec +=== .spec.containers[].livenessProbe.exec Description:: + -- @@ -3142,7 +3292,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].livenessProbe.httpGet +=== .spec.containers[].livenessProbe.httpGet Description:: + -- @@ -3186,7 +3336,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].livenessProbe.httpGet.httpHeaders +=== .spec.containers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -3199,7 +3349,7 @@ Type:: -..spec.containers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.containers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -3228,7 +3378,7 @@ Required:: | The header field value |=== -..spec.containers[].livenessProbe.tcpSocket +=== .spec.containers[].livenessProbe.tcpSocket Description:: + -- @@ -3256,7 +3406,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].ports +=== .spec.containers[].ports Description:: + -- @@ -3269,7 +3419,7 @@ Type:: -..spec.containers[].ports[] +=== .spec.containers[].ports[] Description:: + -- @@ -3309,7 +3459,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.containers[].readinessProbe +=== .spec.containers[].readinessProbe Description:: + -- @@ -3359,7 +3509,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].readinessProbe.exec +=== .spec.containers[].readinessProbe.exec Description:: + -- @@ -3381,7 +3531,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].readinessProbe.httpGet +=== .spec.containers[].readinessProbe.httpGet Description:: + -- @@ -3425,7 +3575,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].readinessProbe.httpGet.httpHeaders +=== .spec.containers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -3438,7 +3588,7 @@ Type:: -..spec.containers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.containers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -3467,7 +3617,7 @@ Required:: | The header field value |=== -..spec.containers[].readinessProbe.tcpSocket +=== .spec.containers[].readinessProbe.tcpSocket Description:: + -- @@ -3495,7 +3645,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].resources +=== .spec.containers[].resources Description:: + -- @@ -3521,7 +3671,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.containers[].securityContext +=== .spec.containers[].securityContext Description:: + -- @@ -3579,7 +3729,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].securityContext.capabilities +=== .spec.containers[].securityContext.capabilities Description:: + -- @@ -3605,7 +3755,7 @@ Type:: | Removed capabilities |=== -..spec.containers[].securityContext.seLinuxOptions +=== .spec.containers[].securityContext.seLinuxOptions Description:: + -- @@ -3639,7 +3789,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.containers[].securityContext.windowsOptions +=== .spec.containers[].securityContext.windowsOptions Description:: + -- @@ -3669,7 +3819,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].startupProbe +=== .spec.containers[].startupProbe Description:: + -- @@ -3719,7 +3869,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].startupProbe.exec +=== .spec.containers[].startupProbe.exec Description:: + -- @@ -3741,7 +3891,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].startupProbe.httpGet +=== .spec.containers[].startupProbe.httpGet Description:: + -- @@ -3785,7 +3935,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].startupProbe.httpGet.httpHeaders +=== .spec.containers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -3798,7 +3948,7 @@ Type:: -..spec.containers[].startupProbe.httpGet.httpHeaders[] +=== .spec.containers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -3827,7 +3977,7 @@ Required:: | The header field value |=== -..spec.containers[].startupProbe.tcpSocket +=== .spec.containers[].startupProbe.tcpSocket Description:: + -- @@ -3855,7 +4005,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].volumeDevices +=== .spec.containers[].volumeDevices Description:: + -- @@ -3868,7 +4018,7 @@ Type:: -..spec.containers[].volumeDevices[] +=== .spec.containers[].volumeDevices[] Description:: + -- @@ -3897,7 +4047,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.containers[].volumeMounts +=== .spec.containers[].volumeMounts Description:: + -- @@ -3910,7 +4060,7 @@ Type:: -..spec.containers[].volumeMounts[] +=== .spec.containers[].volumeMounts[] Description:: + -- @@ -3955,7 +4105,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.imagePullSecrets +=== .spec.imagePullSecrets Description:: + -- @@ -3968,7 +4118,7 @@ Type:: -..spec.imagePullSecrets[] +=== .spec.imagePullSecrets[] Description:: + -- @@ -3990,7 +4140,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.initContainers +=== .spec.initContainers Description:: + -- @@ -4003,7 +4153,7 @@ Type:: -..spec.initContainers[] +=== .spec.initContainers[] Description:: + -- @@ -4131,7 +4281,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.initContainers[].env +=== .spec.initContainers[].env Description:: + -- @@ -4144,7 +4294,7 @@ Type:: -..spec.initContainers[].env[] +=== .spec.initContainers[].env[] Description:: + -- @@ -4176,7 +4326,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.initContainers[].env[].valueFrom +=== .spec.initContainers[].env[].valueFrom Description:: + -- @@ -4210,7 +4360,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.initContainers[].env[].valueFrom.configMapKeyRef +=== .spec.initContainers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -4242,7 +4392,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.initContainers[].env[].valueFrom.fieldRef +=== .spec.initContainers[].env[].valueFrom.fieldRef Description:: + -- @@ -4270,7 +4420,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.initContainers[].env[].valueFrom.resourceFieldRef +=== .spec.initContainers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -4302,7 +4452,7 @@ Required:: | Required: resource to select |=== -..spec.initContainers[].env[].valueFrom.secretKeyRef +=== .spec.initContainers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -4334,7 +4484,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.initContainers[].envFrom +=== .spec.initContainers[].envFrom Description:: + -- @@ -4347,7 +4497,7 @@ Type:: -..spec.initContainers[].envFrom[] +=== .spec.initContainers[].envFrom[] Description:: + -- @@ -4377,7 +4527,7 @@ Type:: | The Secret to select from |=== -..spec.initContainers[].envFrom[].configMapRef +=== .spec.initContainers[].envFrom[].configMapRef Description:: + -- @@ -4403,7 +4553,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.initContainers[].envFrom[].secretRef +=== .spec.initContainers[].envFrom[].secretRef Description:: + -- @@ -4429,7 +4579,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.initContainers[].lifecycle +=== .spec.initContainers[].lifecycle Description:: + -- @@ -4455,7 +4605,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.initContainers[].lifecycle.postStart +=== .spec.initContainers[].lifecycle.postStart Description:: + -- @@ -4485,7 +4635,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.postStart.exec +=== .spec.initContainers[].lifecycle.postStart.exec Description:: + -- @@ -4507,7 +4657,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.postStart.httpGet +=== .spec.initContainers[].lifecycle.postStart.httpGet Description:: + -- @@ -4551,7 +4701,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -4564,7 +4714,7 @@ Type:: -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -4593,7 +4743,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.postStart.tcpSocket +=== .spec.initContainers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -4621,7 +4771,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].lifecycle.preStop +=== .spec.initContainers[].lifecycle.preStop Description:: + -- @@ -4651,7 +4801,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.preStop.exec +=== .spec.initContainers[].lifecycle.preStop.exec Description:: + -- @@ -4673,7 +4823,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.preStop.httpGet +=== .spec.initContainers[].lifecycle.preStop.httpGet Description:: + -- @@ -4717,7 +4867,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -4730,7 +4880,7 @@ Type:: -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -4759,7 +4909,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.preStop.tcpSocket +=== .spec.initContainers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -4787,7 +4937,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].livenessProbe +=== .spec.initContainers[].livenessProbe Description:: + -- @@ -4837,7 +4987,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].livenessProbe.exec +=== .spec.initContainers[].livenessProbe.exec Description:: + -- @@ -4859,7 +5009,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].livenessProbe.httpGet +=== .spec.initContainers[].livenessProbe.httpGet Description:: + -- @@ -4903,7 +5053,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].livenessProbe.httpGet.httpHeaders +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -4916,7 +5066,7 @@ Type:: -..spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4945,7 +5095,7 @@ Required:: | The header field value |=== -..spec.initContainers[].livenessProbe.tcpSocket +=== .spec.initContainers[].livenessProbe.tcpSocket Description:: + -- @@ -4973,7 +5123,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].ports +=== .spec.initContainers[].ports Description:: + -- @@ -4986,7 +5136,7 @@ Type:: -..spec.initContainers[].ports[] +=== .spec.initContainers[].ports[] Description:: + -- @@ -5026,7 +5176,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.initContainers[].readinessProbe +=== .spec.initContainers[].readinessProbe Description:: + -- @@ -5076,7 +5226,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].readinessProbe.exec +=== .spec.initContainers[].readinessProbe.exec Description:: + -- @@ -5098,7 +5248,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].readinessProbe.httpGet +=== .spec.initContainers[].readinessProbe.httpGet Description:: + -- @@ -5142,7 +5292,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].readinessProbe.httpGet.httpHeaders +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -5155,7 +5305,7 @@ Type:: -..spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -5184,7 +5334,7 @@ Required:: | The header field value |=== -..spec.initContainers[].readinessProbe.tcpSocket +=== .spec.initContainers[].readinessProbe.tcpSocket Description:: + -- @@ -5212,7 +5362,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].resources +=== .spec.initContainers[].resources Description:: + -- @@ -5238,7 +5388,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.initContainers[].securityContext +=== .spec.initContainers[].securityContext Description:: + -- @@ -5296,7 +5446,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].securityContext.capabilities +=== .spec.initContainers[].securityContext.capabilities Description:: + -- @@ -5322,7 +5472,7 @@ Type:: | Removed capabilities |=== -..spec.initContainers[].securityContext.seLinuxOptions +=== .spec.initContainers[].securityContext.seLinuxOptions Description:: + -- @@ -5356,7 +5506,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.initContainers[].securityContext.windowsOptions +=== .spec.initContainers[].securityContext.windowsOptions Description:: + -- @@ -5386,7 +5536,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].startupProbe +=== .spec.initContainers[].startupProbe Description:: + -- @@ -5436,7 +5586,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].startupProbe.exec +=== .spec.initContainers[].startupProbe.exec Description:: + -- @@ -5458,7 +5608,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].startupProbe.httpGet +=== .spec.initContainers[].startupProbe.httpGet Description:: + -- @@ -5502,7 +5652,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].startupProbe.httpGet.httpHeaders +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -5515,7 +5665,7 @@ Type:: -..spec.initContainers[].startupProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -5544,7 +5694,7 @@ Required:: | The header field value |=== -..spec.initContainers[].startupProbe.tcpSocket +=== .spec.initContainers[].startupProbe.tcpSocket Description:: + -- @@ -5572,7 +5722,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].volumeDevices +=== .spec.initContainers[].volumeDevices Description:: + -- @@ -5585,7 +5735,7 @@ Type:: -..spec.initContainers[].volumeDevices[] +=== .spec.initContainers[].volumeDevices[] Description:: + -- @@ -5614,7 +5764,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.initContainers[].volumeMounts +=== .spec.initContainers[].volumeMounts Description:: + -- @@ -5627,7 +5777,7 @@ Type:: -..spec.initContainers[].volumeMounts[] +=== .spec.initContainers[].volumeMounts[] Description:: + -- @@ -5672,7 +5822,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.podMetadata +=== .spec.podMetadata Description:: + -- @@ -5702,7 +5852,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.podMonitorNamespaceSelector +=== .spec.podMonitorNamespaceSelector Description:: + -- @@ -5732,7 +5882,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.podMonitorNamespaceSelector.matchExpressions +=== .spec.podMonitorNamespaceSelector.matchExpressions Description:: + -- @@ -5745,7 +5895,7 @@ Type:: -..spec.podMonitorNamespaceSelector.matchExpressions[] +=== .spec.podMonitorNamespaceSelector.matchExpressions[] Description:: + -- @@ -5778,7 +5928,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.podMonitorSelector +=== .spec.podMonitorSelector Description:: + -- @@ -5808,7 +5958,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.podMonitorSelector.matchExpressions +=== .spec.podMonitorSelector.matchExpressions Description:: + -- @@ -5821,7 +5971,7 @@ Type:: -..spec.podMonitorSelector.matchExpressions[] +=== .spec.podMonitorSelector.matchExpressions[] Description:: + -- @@ -5854,7 +6004,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.probeNamespaceSelector +=== .spec.probeNamespaceSelector Description:: + -- @@ -5884,7 +6034,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.probeNamespaceSelector.matchExpressions +=== .spec.probeNamespaceSelector.matchExpressions Description:: + -- @@ -5897,7 +6047,7 @@ Type:: -..spec.probeNamespaceSelector.matchExpressions[] +=== .spec.probeNamespaceSelector.matchExpressions[] Description:: + -- @@ -5930,7 +6080,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.probeSelector +=== .spec.probeSelector Description:: + -- @@ -5960,7 +6110,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.probeSelector.matchExpressions +=== .spec.probeSelector.matchExpressions Description:: + -- @@ -5973,7 +6123,7 @@ Type:: -..spec.probeSelector.matchExpressions[] +=== .spec.probeSelector.matchExpressions[] Description:: + -- @@ -6006,7 +6156,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.prometheusRulesExcludedFromEnforce +=== .spec.prometheusRulesExcludedFromEnforce Description:: + -- @@ -6019,7 +6169,7 @@ Type:: -..spec.prometheusRulesExcludedFromEnforce[] +=== .spec.prometheusRulesExcludedFromEnforce[] Description:: + -- @@ -6048,7 +6198,7 @@ Required:: | RuleNamespace - namespace of excluded rule |=== -..spec.query +=== .spec.query Description:: + -- @@ -6082,7 +6232,7 @@ Type:: | Maximum time a query may take before being aborted. |=== -..spec.remoteRead +=== .spec.remoteRead Description:: + -- @@ -6095,7 +6245,7 @@ Type:: -..spec.remoteRead[] +=== .spec.remoteRead[] Description:: + -- @@ -6114,6 +6264,10 @@ Required:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization section for remote read + | `basicAuth` | `object` | BasicAuth for the URL. @@ -6130,6 +6284,10 @@ Required:: | `string` | The name of the remote read queue, must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. Only valid in Prometheus versions 2.15.0 and newer. +| `oauth2` +| `object` +| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + | `proxyUrl` | `string` | Optional ProxyURL @@ -6155,11 +6313,11 @@ Required:: | The URL of the endpoint to send samples to. |=== -..spec.remoteRead[].basicAuth +=== .spec.remoteRead[].authorization Description:: + -- -BasicAuth for the URL. +Authorization section for remote read -- Type:: @@ -6172,52 +6330,24 @@ Type:: |=== | Property | Type | Description -| `password` -| `object` -| The secret in the service monitor namespace that contains the password for authentication. - -| `username` +| `credentials` | `object` -| The secret in the service monitor namespace that contains the username for authentication. - -|=== -..spec.remoteRead[].basicAuth.password -Description:: -+ --- -The secret in the service monitor namespace that contains the password for authentication. --- - -Type:: - `object` - -Required:: - - `key` - - +| The secret's key that contains the credentials of the request -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `key` +| `credentialsFile` | `string` -| The key of the secret to select from. Must be a valid secret key. +| File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization) -| `name` +| `type` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? - -| `optional` -| `boolean` -| Specify whether the Secret or its key must be defined +| Set the authentication type. Defaults to Bearer, Basic will cause an error |=== -..spec.remoteRead[].basicAuth.username +=== .spec.remoteRead[].authorization.credentials Description:: + -- -The secret in the service monitor namespace that contains the username for authentication. +The secret's key that contains the credentials of the request -- Type:: @@ -6245,11 +6375,11 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteRead[].tlsConfig +=== .spec.remoteRead[].basicAuth Description:: + -- -TLS Config to use for remote read. +BasicAuth for the URL. -- Type:: @@ -6262,49 +6392,27 @@ Type:: |=== | Property | Type | Description -| `ca` -| `object` -| Struct containing the CA cert to use for the targets. - -| `caFile` -| `string` -| Path to the CA cert in the Prometheus container to use for the targets. - -| `cert` +| `password` | `object` -| Struct containing the client cert file for the targets. - -| `certFile` -| `string` -| Path to the client cert file in the Prometheus container for the targets. - -| `insecureSkipVerify` -| `boolean` -| Disable target certificate validation. - -| `keyFile` -| `string` -| Path to the client key file in the Prometheus container for the targets. +| The secret in the service monitor namespace that contains the password for authentication. -| `keySecret` +| `username` | `object` -| Secret containing the client key file for the targets. - -| `serverName` -| `string` -| Used to verify the hostname for the targets. +| The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.remoteRead[].tlsConfig.ca +=== .spec.remoteRead[].basicAuth.password Description:: + -- -Struct containing the CA cert to use for the targets. +The secret in the service monitor namespace that contains the password for authentication. -- Type:: `object` +Required:: + - `key` @@ -6312,20 +6420,24 @@ Type:: |=== | Property | Type | Description -| `configMap` -| `object` -| ConfigMap containing data to use for the targets. +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. -| `secret` -| `object` -| Secret containing data to use for the targets. +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined |=== -..spec.remoteRead[].tlsConfig.ca.configMap +=== .spec.remoteRead[].basicAuth.username Description:: + -- -ConfigMap containing data to use for the targets. +The secret in the service monitor namespace that contains the username for authentication. -- Type:: @@ -6342,7 +6454,7 @@ Required:: | `key` | `string` -| The key to select. +| The key of the secret to select from. Must be a valid secret key. | `name` | `string` @@ -6350,21 +6462,23 @@ Required:: | `optional` | `boolean` -| Specify whether the ConfigMap or its key must be defined +| Specify whether the Secret or its key must be defined |=== -..spec.remoteRead[].tlsConfig.ca.secret +=== .spec.remoteRead[].oauth2 Description:: + -- -Secret containing data to use for the targets. +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. -- Type:: `object` Required:: - - `key` + - `clientId` + - `clientSecret` + - `tokenUrl` @@ -6372,24 +6486,32 @@ Required:: |=== | Property | Type | Description -| `key` -| `string` -| The key of the secret to select from. Must be a valid secret key. +| `clientId` +| `object` +| The secret or configmap containing the OAuth2 client id -| `name` -| `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +| `clientSecret` +| `object` +| The secret containing the OAuth2 client secret -| `optional` -| `boolean` -| Specify whether the Secret or its key must be defined +| `endpointParams` +| `object (string)` +| Parameters to append to the token URL + +| `scopes` +| `array (string)` +| OAuth2 scopes used for the token request + +| `tokenUrl` +| `string` +| The URL to fetch the token from |=== -..spec.remoteRead[].tlsConfig.cert +=== .spec.remoteRead[].oauth2.clientId Description:: + -- -Struct containing the client cert file for the targets. +The secret or configmap containing the OAuth2 client id -- Type:: @@ -6411,7 +6533,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.remoteRead[].tlsConfig.cert.configMap +=== .spec.remoteRead[].oauth2.clientId.configMap Description:: + -- @@ -6443,7 +6565,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.remoteRead[].tlsConfig.cert.secret +=== .spec.remoteRead[].oauth2.clientId.secret Description:: + -- @@ -6475,11 +6597,11 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteRead[].tlsConfig.keySecret +=== .spec.remoteRead[].oauth2.clientSecret Description:: + -- -Secret containing the client key file for the targets. +The secret containing the OAuth2 client secret -- Type:: @@ -6507,31 +6629,16 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite -Description:: -+ --- -If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way. --- - -Type:: - `array` - - - - -..spec.remoteWrite[] +=== .spec.remoteRead[].tlsConfig Description:: + -- -RemoteWriteSpec defines the remote_write configuration for prometheus. +TLS Config to use for remote read. -- Type:: `object` -Required:: - - `url` @@ -6539,7 +6646,288 @@ Required:: |=== | Property | Type | Description -| `basicAuth` +| `ca` +| `object` +| Struct containing the CA cert to use for the targets. + +| `caFile` +| `string` +| Path to the CA cert in the Prometheus container to use for the targets. + +| `cert` +| `object` +| Struct containing the client cert file for the targets. + +| `certFile` +| `string` +| Path to the client cert file in the Prometheus container for the targets. + +| `insecureSkipVerify` +| `boolean` +| Disable target certificate validation. + +| `keyFile` +| `string` +| Path to the client key file in the Prometheus container for the targets. + +| `keySecret` +| `object` +| Secret containing the client key file for the targets. + +| `serverName` +| `string` +| Used to verify the hostname for the targets. + +|=== +=== .spec.remoteRead[].tlsConfig.ca +Description:: ++ +-- +Struct containing the CA cert to use for the targets. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.remoteRead[].tlsConfig.ca.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.remoteRead[].tlsConfig.ca.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.remoteRead[].tlsConfig.cert +Description:: ++ +-- +Struct containing the client cert file for the targets. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.remoteRead[].tlsConfig.cert.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.remoteRead[].tlsConfig.cert.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.remoteRead[].tlsConfig.keySecret +Description:: ++ +-- +Secret containing the client key file for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.remoteWrite +Description:: ++ +-- +If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way. +-- + +Type:: + `array` + + + + +=== .spec.remoteWrite[] +Description:: ++ +-- +RemoteWriteSpec defines the remote_write configuration for prometheus. +-- + +Type:: + `object` + +Required:: + - `url` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `authorization` +| `object` +| Authorization section for remote write + +| `basicAuth` | `object` | BasicAuth for the URL. @@ -6555,44 +6943,114 @@ Required:: | `object (string)` | Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.25.0 and newer. -| `metadataConfig` +| `metadataConfig` +| `object` +| MetadataConfig configures the sending of series metadata to remote storage. + +| `name` +| `string` +| The name of the remote write queue, must be unique if specified. The name is used in metrics and logging in order to differentiate queues. Only valid in Prometheus versions 2.15.0 and newer. + +| `oauth2` +| `object` +| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + +| `proxyUrl` +| `string` +| Optional ProxyURL + +| `queueConfig` +| `object` +| QueueConfig allows tuning of the remote write queue parameters. + +| `remoteTimeout` +| `string` +| Timeout for requests to the remote write endpoint. + +| `sendExemplars` +| `boolean` +| Enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the enableFeature option for exemplars to be scraped in the first place. Only valid in Prometheus versions 2.27.0 and newer. + +| `tlsConfig` +| `object` +| TLS Config to use for remote write. + +| `url` +| `string` +| The URL of the endpoint to send samples to. + +| `writeRelabelConfigs` +| `array` +| The list of remote write relabel configurations. + +| `writeRelabelConfigs[]` +| `object` +| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs + +|=== +=== .spec.remoteWrite[].authorization +Description:: ++ +-- +Authorization section for remote write +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` | `object` -| MetadataConfig configures the sending of series metadata to remote storage. +| The secret's key that contains the credentials of the request -| `name` +| `credentialsFile` | `string` -| The name of the remote write queue, must be unique if specified. The name is used in metrics and logging in order to differentiate queues. Only valid in Prometheus versions 2.15.0 and newer. +| File to read a secret from, mutually exclusive with Credentials (from SafeAuthorization) -| `proxyUrl` +| `type` | `string` -| Optional ProxyURL +| Set the authentication type. Defaults to Bearer, Basic will cause an error -| `queueConfig` -| `object` -| QueueConfig allows tuning of the remote write queue parameters. +|=== +=== .spec.remoteWrite[].authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- -| `remoteTimeout` -| `string` -| Timeout for requests to the remote write endpoint. +Type:: + `object` -| `tlsConfig` -| `object` -| TLS Config to use for remote write. +Required:: + - `key` -| `url` + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` | `string` -| The URL of the endpoint to send samples to. +| The key of the secret to select from. Must be a valid secret key. -| `writeRelabelConfigs` -| `array` -| The list of remote write relabel configurations. +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? -| `writeRelabelConfigs[]` -| `object` -| RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].basicAuth +=== .spec.remoteWrite[].basicAuth Description:: + -- @@ -6618,7 +7076,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.remoteWrite[].basicAuth.password +=== .spec.remoteWrite[].basicAuth.password Description:: + -- @@ -6650,7 +7108,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].basicAuth.username +=== .spec.remoteWrite[].basicAuth.username Description:: + -- @@ -6682,7 +7140,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].metadataConfig +=== .spec.remoteWrite[].metadataConfig Description:: + -- @@ -6708,7 +7166,171 @@ Type:: | How frequently metric metadata is sent to remote storage. |=== -..spec.remoteWrite[].queueConfig +=== .spec.remoteWrite[].oauth2 +Description:: ++ +-- +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. +-- + +Type:: + `object` + +Required:: + - `clientId` + - `clientSecret` + - `tokenUrl` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `clientId` +| `object` +| The secret or configmap containing the OAuth2 client id + +| `clientSecret` +| `object` +| The secret containing the OAuth2 client secret + +| `endpointParams` +| `object (string)` +| Parameters to append to the token URL + +| `scopes` +| `array (string)` +| OAuth2 scopes used for the token request + +| `tokenUrl` +| `string` +| The URL to fetch the token from + +|=== +=== .spec.remoteWrite[].oauth2.clientId +Description:: ++ +-- +The secret or configmap containing the OAuth2 client id +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.remoteWrite[].oauth2.clientId.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.remoteWrite[].oauth2.clientId.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.remoteWrite[].oauth2.clientSecret +Description:: ++ +-- +The secret containing the OAuth2 client secret +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.remoteWrite[].queueConfig Description:: + -- @@ -6758,7 +7380,7 @@ Type:: | MinShards is the minimum number of shards, i.e. amount of concurrency. |=== -..spec.remoteWrite[].tlsConfig +=== .spec.remoteWrite[].tlsConfig Description:: + -- @@ -6808,7 +7430,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.remoteWrite[].tlsConfig.ca +=== .spec.remoteWrite[].tlsConfig.ca Description:: + -- @@ -6834,7 +7456,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.remoteWrite[].tlsConfig.ca.configMap +=== .spec.remoteWrite[].tlsConfig.ca.configMap Description:: + -- @@ -6866,7 +7488,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.remoteWrite[].tlsConfig.ca.secret +=== .spec.remoteWrite[].tlsConfig.ca.secret Description:: + -- @@ -6898,7 +7520,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].tlsConfig.cert +=== .spec.remoteWrite[].tlsConfig.cert Description:: + -- @@ -6924,7 +7546,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.remoteWrite[].tlsConfig.cert.configMap +=== .spec.remoteWrite[].tlsConfig.cert.configMap Description:: + -- @@ -6956,7 +7578,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.remoteWrite[].tlsConfig.cert.secret +=== .spec.remoteWrite[].tlsConfig.cert.secret Description:: + -- @@ -6988,7 +7610,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].tlsConfig.keySecret +=== .spec.remoteWrite[].tlsConfig.keySecret Description:: + -- @@ -7020,7 +7642,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.remoteWrite[].writeRelabelConfigs +=== .spec.remoteWrite[].writeRelabelConfigs Description:: + -- @@ -7033,7 +7655,7 @@ Type:: -..spec.remoteWrite[].writeRelabelConfigs[] +=== .spec.remoteWrite[].writeRelabelConfigs[] Description:: + -- @@ -7079,7 +7701,7 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.resources +=== .spec.resources Description:: + -- @@ -7105,7 +7727,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.ruleNamespaceSelector +=== .spec.ruleNamespaceSelector Description:: + -- @@ -7135,7 +7757,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.ruleNamespaceSelector.matchExpressions +=== .spec.ruleNamespaceSelector.matchExpressions Description:: + -- @@ -7148,7 +7770,7 @@ Type:: -..spec.ruleNamespaceSelector.matchExpressions[] +=== .spec.ruleNamespaceSelector.matchExpressions[] Description:: + -- @@ -7181,7 +7803,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.ruleSelector +=== .spec.ruleSelector Description:: + -- @@ -7211,7 +7833,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.ruleSelector.matchExpressions +=== .spec.ruleSelector.matchExpressions Description:: + -- @@ -7224,7 +7846,7 @@ Type:: -..spec.ruleSelector.matchExpressions[] +=== .spec.ruleSelector.matchExpressions[] Description:: + -- @@ -7257,7 +7879,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.rules +=== .spec.rules Description:: + -- @@ -7279,7 +7901,7 @@ Type:: | /--rules.alert.*/ command-line arguments |=== -..spec.rules.alert +=== .spec.rules.alert Description:: + -- @@ -7309,7 +7931,7 @@ Type:: | Minimum amount of time to wait before resending an alert to Alertmanager. |=== -..spec.securityContext +=== .spec.securityContext Description:: + -- @@ -7369,7 +7991,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.securityContext.seLinuxOptions +=== .spec.securityContext.seLinuxOptions Description:: + -- @@ -7403,7 +8025,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.securityContext.sysctls +=== .spec.securityContext.sysctls Description:: + -- @@ -7416,7 +8038,7 @@ Type:: -..spec.securityContext.sysctls[] +=== .spec.securityContext.sysctls[] Description:: + -- @@ -7445,7 +8067,7 @@ Required:: | Value of a property to set |=== -..spec.securityContext.windowsOptions +=== .spec.securityContext.windowsOptions Description:: + -- @@ -7475,7 +8097,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.serviceMonitorNamespaceSelector +=== .spec.serviceMonitorNamespaceSelector Description:: + -- @@ -7505,7 +8127,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.serviceMonitorNamespaceSelector.matchExpressions +=== .spec.serviceMonitorNamespaceSelector.matchExpressions Description:: + -- @@ -7518,7 +8140,7 @@ Type:: -..spec.serviceMonitorNamespaceSelector.matchExpressions[] +=== .spec.serviceMonitorNamespaceSelector.matchExpressions[] Description:: + -- @@ -7551,7 +8173,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.serviceMonitorSelector +=== .spec.serviceMonitorSelector Description:: + -- @@ -7581,7 +8203,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.serviceMonitorSelector.matchExpressions +=== .spec.serviceMonitorSelector.matchExpressions Description:: + -- @@ -7594,7 +8216,7 @@ Type:: -..spec.serviceMonitorSelector.matchExpressions[] +=== .spec.serviceMonitorSelector.matchExpressions[] Description:: + -- @@ -7627,7 +8249,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.storage +=== .spec.storage Description:: + -- @@ -7657,7 +8279,7 @@ Type:: | A PVC spec to be used by the Prometheus StatefulSets. |=== -..spec.storage.emptyDir +=== .spec.storage.emptyDir Description:: + -- @@ -7683,7 +8305,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.storage.volumeClaimTemplate +=== .spec.storage.volumeClaimTemplate Description:: + -- @@ -7721,7 +8343,7 @@ Type:: | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |=== -..spec.storage.volumeClaimTemplate.metadata +=== .spec.storage.volumeClaimTemplate.metadata Description:: + -- @@ -7751,7 +8373,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.storage.volumeClaimTemplate.spec +=== .spec.storage.volumeClaimTemplate.spec Description:: + -- @@ -7797,7 +8419,7 @@ Type:: | VolumeName is the binding reference to the PersistentVolume backing this claim. |=== -..spec.storage.volumeClaimTemplate.spec.dataSource +=== .spec.storage.volumeClaimTemplate.spec.dataSource Description:: + -- @@ -7830,7 +8452,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.storage.volumeClaimTemplate.spec.resources +=== .spec.storage.volumeClaimTemplate.spec.resources Description:: + -- @@ -7856,7 +8478,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.storage.volumeClaimTemplate.spec.selector +=== .spec.storage.volumeClaimTemplate.spec.selector Description:: + -- @@ -7886,7 +8508,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Description:: + -- @@ -7899,7 +8521,7 @@ Type:: -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Description:: + -- @@ -7932,7 +8554,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.storage.volumeClaimTemplate.status +=== .spec.storage.volumeClaimTemplate.status Description:: + -- @@ -7970,7 +8592,7 @@ Type:: | Phase represents the current phase of PersistentVolumeClaim. |=== -..spec.storage.volumeClaimTemplate.status.conditions +=== .spec.storage.volumeClaimTemplate.status.conditions Description:: + -- @@ -7983,7 +8605,7 @@ Type:: -..spec.storage.volumeClaimTemplate.status.conditions[] +=== .spec.storage.volumeClaimTemplate.status.conditions[] Description:: + -- @@ -8028,7 +8650,7 @@ Required:: | PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type |=== -..spec.thanos +=== .spec.thanos Description:: + -- @@ -8111,8 +8733,16 @@ Type:: | `string` | Version describes the version of Thanos to use. +| `volumeMounts` +| `array` +| VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the thanos-sidecar container. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + |=== -..spec.thanos.grpcServerTlsConfig +=== .spec.thanos.grpcServerTlsConfig Description:: + -- @@ -8162,7 +8792,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.thanos.grpcServerTlsConfig.ca +=== .spec.thanos.grpcServerTlsConfig.ca Description:: + -- @@ -8188,7 +8818,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.thanos.grpcServerTlsConfig.ca.configMap +=== .spec.thanos.grpcServerTlsConfig.ca.configMap Description:: + -- @@ -8220,7 +8850,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.thanos.grpcServerTlsConfig.ca.secret +=== .spec.thanos.grpcServerTlsConfig.ca.secret Description:: + -- @@ -8252,7 +8882,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.thanos.grpcServerTlsConfig.cert +=== .spec.thanos.grpcServerTlsConfig.cert Description:: + -- @@ -8278,7 +8908,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.thanos.grpcServerTlsConfig.cert.configMap +=== .spec.thanos.grpcServerTlsConfig.cert.configMap Description:: + -- @@ -8310,7 +8940,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.thanos.grpcServerTlsConfig.cert.secret +=== .spec.thanos.grpcServerTlsConfig.cert.secret Description:: + -- @@ -8342,7 +8972,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.thanos.grpcServerTlsConfig.keySecret +=== .spec.thanos.grpcServerTlsConfig.keySecret Description:: + -- @@ -8374,7 +9004,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.thanos.objectStorageConfig +=== .spec.thanos.objectStorageConfig Description:: + -- @@ -8406,7 +9036,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.thanos.resources +=== .spec.thanos.resources Description:: + -- @@ -8432,7 +9062,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.thanos.tracingConfig +=== .spec.thanos.tracingConfig Description:: + -- @@ -8464,7 +9094,65 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.tolerations +=== .spec.thanos.volumeMounts +Description:: ++ +-- +VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the thanos-sidecar container. +-- + +Type:: + `array` + + + + +=== .spec.thanos.volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `mountPath` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.tolerations Description:: + -- @@ -8477,7 +9165,7 @@ Type:: -..spec.tolerations[] +=== .spec.tolerations[] Description:: + -- @@ -8515,7 +9203,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.topologySpreadConstraints +=== .spec.topologySpreadConstraints Description:: + -- @@ -8528,7 +9216,7 @@ Type:: -..spec.topologySpreadConstraints[] +=== .spec.topologySpreadConstraints[] Description:: + -- @@ -8566,7 +9254,7 @@ Required:: | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. |=== -..spec.topologySpreadConstraints[].labelSelector +=== .spec.topologySpreadConstraints[].labelSelector Description:: + -- @@ -8596,7 +9284,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.topologySpreadConstraints[].labelSelector.matchExpressions +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions Description:: + -- @@ -8609,7 +9297,7 @@ Type:: -..spec.topologySpreadConstraints[].labelSelector.matchExpressions[] +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Description:: + -- @@ -8642,7 +9330,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.volumeMounts +=== .spec.volumeMounts Description:: + -- @@ -8655,7 +9343,7 @@ Type:: -..spec.volumeMounts[] +=== .spec.volumeMounts[] Description:: + -- @@ -8700,7 +9388,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.volumes +=== .spec.volumes Description:: + -- @@ -8713,7 +9401,7 @@ Type:: -..spec.volumes[] +=== .spec.volumes[] Description:: + -- @@ -8849,7 +9537,7 @@ Required:: | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -..spec.volumes[].awsElasticBlockStore +=== .spec.volumes[].awsElasticBlockStore Description:: + -- @@ -8885,7 +9573,7 @@ Required:: | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |=== -..spec.volumes[].azureDisk +=== .spec.volumes[].azureDisk Description:: + -- @@ -8930,7 +9618,7 @@ Required:: | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |=== -..spec.volumes[].azureFile +=== .spec.volumes[].azureFile Description:: + -- @@ -8963,7 +9651,7 @@ Required:: | Share Name |=== -..spec.volumes[].cephfs +=== .spec.volumes[].cephfs Description:: + -- @@ -9007,7 +9695,7 @@ Required:: | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |=== -..spec.volumes[].cephfs.secretRef +=== .spec.volumes[].cephfs.secretRef Description:: + -- @@ -9029,7 +9717,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].cinder +=== .spec.volumes[].cinder Description:: + -- @@ -9065,7 +9753,7 @@ Required:: | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |=== -..spec.volumes[].cinder.secretRef +=== .spec.volumes[].cinder.secretRef Description:: + -- @@ -9087,7 +9775,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].configMap +=== .spec.volumes[].configMap Description:: + -- @@ -9125,7 +9813,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].configMap.items +=== .spec.volumes[].configMap.items Description:: + -- @@ -9138,7 +9826,7 @@ Type:: -..spec.volumes[].configMap.items[] +=== .spec.volumes[].configMap.items[] Description:: + -- @@ -9171,7 +9859,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].csi +=== .spec.volumes[].csi Description:: + -- @@ -9211,7 +9899,7 @@ Required:: | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. |=== -..spec.volumes[].csi.nodePublishSecretRef +=== .spec.volumes[].csi.nodePublishSecretRef Description:: + -- @@ -9233,7 +9921,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].downwardAPI +=== .spec.volumes[].downwardAPI Description:: + -- @@ -9263,7 +9951,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].downwardAPI.items +=== .spec.volumes[].downwardAPI.items Description:: + -- @@ -9276,7 +9964,7 @@ Type:: -..spec.volumes[].downwardAPI.items[] +=== .spec.volumes[].downwardAPI.items[] Description:: + -- @@ -9312,7 +10000,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].downwardAPI.items[].fieldRef +=== .spec.volumes[].downwardAPI.items[].fieldRef Description:: + -- @@ -9340,7 +10028,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -9372,7 +10060,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].emptyDir +=== .spec.volumes[].emptyDir Description:: + -- @@ -9398,7 +10086,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.volumes[].fc +=== .spec.volumes[].fc Description:: + -- @@ -9436,7 +10124,7 @@ Type:: | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |=== -..spec.volumes[].flexVolume +=== .spec.volumes[].flexVolume Description:: + -- @@ -9476,7 +10164,7 @@ Required:: | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |=== -..spec.volumes[].flexVolume.secretRef +=== .spec.volumes[].flexVolume.secretRef Description:: + -- @@ -9498,7 +10186,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].flocker +=== .spec.volumes[].flocker Description:: + -- @@ -9524,7 +10212,7 @@ Type:: | UUID of the dataset. This is unique identifier of a Flocker dataset |=== -..spec.volumes[].gcePersistentDisk +=== .spec.volumes[].gcePersistentDisk Description:: + -- @@ -9560,7 +10248,7 @@ Required:: | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |=== -..spec.volumes[].gitRepo +=== .spec.volumes[].gitRepo Description:: + -- @@ -9592,7 +10280,7 @@ Required:: | Commit hash for the specified revision. |=== -..spec.volumes[].glusterfs +=== .spec.volumes[].glusterfs Description:: + -- @@ -9625,7 +10313,7 @@ Required:: | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |=== -..spec.volumes[].hostPath +=== .spec.volumes[].hostPath Description:: + -- @@ -9653,7 +10341,7 @@ Required:: | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |=== -..spec.volumes[].iscsi +=== .spec.volumes[].iscsi Description:: + -- @@ -9719,7 +10407,7 @@ Required:: | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |=== -..spec.volumes[].iscsi.secretRef +=== .spec.volumes[].iscsi.secretRef Description:: + -- @@ -9741,7 +10429,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].nfs +=== .spec.volumes[].nfs Description:: + -- @@ -9774,7 +10462,7 @@ Required:: | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |=== -..spec.volumes[].persistentVolumeClaim +=== .spec.volumes[].persistentVolumeClaim Description:: + -- @@ -9802,7 +10490,7 @@ Required:: | Will force the ReadOnly setting in VolumeMounts. Default false. |=== -..spec.volumes[].photonPersistentDisk +=== .spec.volumes[].photonPersistentDisk Description:: + -- @@ -9830,7 +10518,7 @@ Required:: | ID that identifies Photon Controller persistent disk |=== -..spec.volumes[].portworxVolume +=== .spec.volumes[].portworxVolume Description:: + -- @@ -9862,7 +10550,7 @@ Required:: | VolumeID uniquely identifies a Portworx volume |=== -..spec.volumes[].projected +=== .spec.volumes[].projected Description:: + -- @@ -9894,7 +10582,7 @@ Required:: | Projection that may be projected along with other supported volume types |=== -..spec.volumes[].projected.sources +=== .spec.volumes[].projected.sources Description:: + -- @@ -9907,7 +10595,7 @@ Type:: -..spec.volumes[].projected.sources[] +=== .spec.volumes[].projected.sources[] Description:: + -- @@ -9941,7 +10629,7 @@ Type:: | information about the serviceAccountToken data to project |=== -..spec.volumes[].projected.sources[].configMap +=== .spec.volumes[].projected.sources[].configMap Description:: + -- @@ -9975,7 +10663,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].projected.sources[].configMap.items +=== .spec.volumes[].projected.sources[].configMap.items Description:: + -- @@ -9988,7 +10676,7 @@ Type:: -..spec.volumes[].projected.sources[].configMap.items[] +=== .spec.volumes[].projected.sources[].configMap.items[] Description:: + -- @@ -10021,7 +10709,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].downwardAPI +=== .spec.volumes[].projected.sources[].downwardAPI Description:: + -- @@ -10047,7 +10735,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].projected.sources[].downwardAPI.items +=== .spec.volumes[].projected.sources[].downwardAPI.items Description:: + -- @@ -10060,7 +10748,7 @@ Type:: -..spec.volumes[].projected.sources[].downwardAPI.items[] +=== .spec.volumes[].projected.sources[].downwardAPI.items[] Description:: + -- @@ -10096,7 +10784,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description:: + -- @@ -10124,7 +10812,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -10156,7 +10844,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].projected.sources[].secret +=== .spec.volumes[].projected.sources[].secret Description:: + -- @@ -10190,7 +10878,7 @@ Type:: | Specify whether the Secret or its key must be defined |=== -..spec.volumes[].projected.sources[].secret.items +=== .spec.volumes[].projected.sources[].secret.items Description:: + -- @@ -10203,7 +10891,7 @@ Type:: -..spec.volumes[].projected.sources[].secret.items[] +=== .spec.volumes[].projected.sources[].secret.items[] Description:: + -- @@ -10236,7 +10924,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].serviceAccountToken +=== .spec.volumes[].projected.sources[].serviceAccountToken Description:: + -- @@ -10268,7 +10956,7 @@ Required:: | Path is the path relative to the mount point of the file to project the token into. |=== -..spec.volumes[].quobyte +=== .spec.volumes[].quobyte Description:: + -- @@ -10313,7 +11001,7 @@ Required:: | Volume is a string that references an already created Quobyte volume by name. |=== -..spec.volumes[].rbd +=== .spec.volumes[].rbd Description:: + -- @@ -10366,7 +11054,7 @@ Required:: | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |=== -..spec.volumes[].rbd.secretRef +=== .spec.volumes[].rbd.secretRef Description:: + -- @@ -10388,7 +11076,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].scaleIO +=== .spec.volumes[].scaleIO Description:: + -- @@ -10450,7 +11138,7 @@ Required:: | The name of a volume already created in the ScaleIO system that is associated with this volume source. |=== -..spec.volumes[].scaleIO.secretRef +=== .spec.volumes[].scaleIO.secretRef Description:: + -- @@ -10472,7 +11160,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].secret +=== .spec.volumes[].secret Description:: + -- @@ -10510,7 +11198,7 @@ Type:: | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -..spec.volumes[].secret.items +=== .spec.volumes[].secret.items Description:: + -- @@ -10523,7 +11211,7 @@ Type:: -..spec.volumes[].secret.items[] +=== .spec.volumes[].secret.items[] Description:: + -- @@ -10556,7 +11244,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].storageos +=== .spec.volumes[].storageos Description:: + -- @@ -10594,7 +11282,7 @@ Type:: | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |=== -..spec.volumes[].storageos.secretRef +=== .spec.volumes[].storageos.secretRef Description:: + -- @@ -10616,7 +11304,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].vsphereVolume +=== .spec.volumes[].vsphereVolume Description:: + -- @@ -10652,7 +11340,7 @@ Required:: | Path that identifies vSphere volume vmdk |=== -..spec.web +=== .spec.web Description:: + -- @@ -10678,7 +11366,7 @@ Type:: | WebTLSConfig defines the TLS parameters for HTTPS. |=== -..spec.web.tlsConfig +=== .spec.web.tlsConfig Description:: + -- @@ -10735,7 +11423,7 @@ Required:: | Controls whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in the order of elements in cipherSuites, is used. |=== -..spec.web.tlsConfig.cert +=== .spec.web.tlsConfig.cert Description:: + -- @@ -10761,7 +11449,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.web.tlsConfig.cert.configMap +=== .spec.web.tlsConfig.cert.configMap Description:: + -- @@ -10793,7 +11481,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.web.tlsConfig.cert.secret +=== .spec.web.tlsConfig.cert.secret Description:: + -- @@ -10825,7 +11513,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.web.tlsConfig.client_ca +=== .spec.web.tlsConfig.client_ca Description:: + -- @@ -10851,7 +11539,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.web.tlsConfig.client_ca.configMap +=== .spec.web.tlsConfig.client_ca.configMap Description:: + -- @@ -10883,7 +11571,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.web.tlsConfig.client_ca.secret +=== .spec.web.tlsConfig.client_ca.secret Description:: + -- @@ -10915,7 +11603,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.web.tlsConfig.keySecret +=== .spec.web.tlsConfig.keySecret Description:: + -- @@ -10947,7 +11635,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..status +=== .status Description:: + -- @@ -11068,7 +11756,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#prometheuslist-monitoring-coreos-com-v1[`PrometheusList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PrometheusList[`PrometheusList`] schema +| 401 - Unauthorized +| Empty |=== @@ -11146,7 +11836,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -11203,7 +11895,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#prometheuslist-monitoring-coreos-com-v1[`PrometheusList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PrometheusList[`PrometheusList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -11230,7 +11924,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema | |=== @@ -11239,7 +11933,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 201 - Created +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 202 - Accepted +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 401 - Unauthorized +| Empty |=== @@ -11296,7 +11996,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -11305,7 +12005,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -11332,7 +12036,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -11359,7 +12065,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -11368,7 +12074,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -11395,7 +12103,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema | |=== @@ -11404,7 +12112,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 201 - Created +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`Prometheus`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc index 714714077bc5..f7a427ce4f37 100644 --- a/rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="prometheusrule-monitoring-coreos-com-v1"] = PrometheusRule [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | Specification of desired alerting rule definitions for Prometheus. |=== -..spec +=== .spec Description:: + -- @@ -69,7 +71,7 @@ Type:: | RuleGroup is a list of sequentially evaluated recording and alerting rules. Note: PartialResponseStrategy is only used by ThanosRuler and will be ignored by Prometheus instances. Valid values for this field are 'warn' or 'abort'. More info: https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md#partial-response |=== -..spec.groups +=== .spec.groups Description:: + -- @@ -82,7 +84,7 @@ Type:: -..spec.groups[] +=== .spec.groups[] Description:: + -- @@ -123,7 +125,7 @@ Required:: | Rule describes an alerting or recording rule See Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule |=== -..spec.groups[].rules +=== .spec.groups[].rules Description:: + -- @@ -136,7 +138,7 @@ Type:: -..spec.groups[].rules[] +=== .spec.groups[].rules[] Description:: + -- @@ -257,7 +259,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#prometheusrulelist-monitoring-coreos-com-v1[`PrometheusRuleList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PrometheusRuleList[`PrometheusRuleList`] schema +| 401 - Unauthorized +| Empty |=== @@ -335,7 +339,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -392,7 +398,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#prometheusrulelist-monitoring-coreos-com-v1[`PrometheusRuleList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.PrometheusRuleList[`PrometheusRuleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -419,7 +427,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema | |=== @@ -428,7 +436,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 201 - Created +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 202 - Accepted +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 401 - Unauthorized +| Empty |=== @@ -485,7 +499,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -494,7 +508,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -521,7 +539,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -548,7 +568,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -557,7 +577,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -584,7 +606,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema | |=== @@ -593,7 +615,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule monitoring.coreos.com/v1`] +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 201 - Created +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`PrometheusRule`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc index e0db85b139a4..81f6bfc4ecb3 100644 --- a/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="servicemonitor-monitoring-coreos-com-v1"] = ServiceMonitor [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | Specification of desired Service selection for target discovery by Prometheus. |=== -..spec +=== .spec Description:: + -- @@ -76,6 +78,18 @@ Required:: | Chooses the label of the Kubernetes `Endpoints`. Its value will be used for the `job`-label's value of the created metrics. Default & fallback value: the name of the respective Kubernetes `Endpoint`. +| `labelLimit` +| `integer` +| Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelNameLengthLimit` +| `integer` +| Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + +| `labelValueLengthLimit` +| `integer` +| Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + | `namespaceSelector` | `object` | Selector to select which namespaces the Kubernetes Endpoints objects are discovered from. @@ -101,7 +115,7 @@ Required:: | TargetLimit defines a limit on the number of scraped targets that will be accepted. |=== -..spec.endpoints +=== .spec.endpoints Description:: + -- @@ -114,7 +128,7 @@ Type:: -..spec.endpoints[] +=== .spec.endpoints[] Description:: + -- @@ -131,6 +145,10 @@ Type:: |=== | Property | Type | Description +| `authorization` +| `object` +| Authorization section for this endpoint + | `basicAuth` | `object` | BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints @@ -163,6 +181,10 @@ Type:: | `object` | RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines ``-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs +| `oauth2` +| `object` +| OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + | `params` | `object` | Optional HTTP URL parameters @@ -208,7 +230,65 @@ Type:: | TLS configuration to use when scraping the endpoint |=== -..spec.endpoints[].basicAuth +=== .spec.endpoints[].authorization +Description:: ++ +-- +Authorization section for this endpoint +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `credentials` +| `object` +| The secret's key that contains the credentials of the request + +| `type` +| `string` +| Set the authentication type. Defaults to Bearer, Basic will cause an error + +|=== +=== .spec.endpoints[].authorization.credentials +Description:: ++ +-- +The secret's key that contains the credentials of the request +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.endpoints[].basicAuth Description:: + -- @@ -234,7 +314,7 @@ Type:: | The secret in the service monitor namespace that contains the username for authentication. |=== -..spec.endpoints[].basicAuth.password +=== .spec.endpoints[].basicAuth.password Description:: + -- @@ -266,7 +346,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.endpoints[].basicAuth.username +=== .spec.endpoints[].basicAuth.username Description:: + -- @@ -298,7 +378,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.endpoints[].bearerTokenSecret +=== .spec.endpoints[].bearerTokenSecret Description:: + -- @@ -330,7 +410,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.endpoints[].metricRelabelings +=== .spec.endpoints[].metricRelabelings Description:: + -- @@ -343,7 +423,7 @@ Type:: -..spec.endpoints[].metricRelabelings[] +=== .spec.endpoints[].metricRelabelings[] Description:: + -- @@ -389,7 +469,171 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.endpoints[].params +=== .spec.endpoints[].oauth2 +Description:: ++ +-- +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. +-- + +Type:: + `object` + +Required:: + - `clientId` + - `clientSecret` + - `tokenUrl` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `clientId` +| `object` +| The secret or configmap containing the OAuth2 client id + +| `clientSecret` +| `object` +| The secret containing the OAuth2 client secret + +| `endpointParams` +| `object (string)` +| Parameters to append to the token URL + +| `scopes` +| `array (string)` +| OAuth2 scopes used for the token request + +| `tokenUrl` +| `string` +| The URL to fetch the token from + +|=== +=== .spec.endpoints[].oauth2.clientId +Description:: ++ +-- +The secret or configmap containing the OAuth2 client id +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMap containing data to use for the targets. + +| `secret` +| `object` +| Secret containing data to use for the targets. + +|=== +=== .spec.endpoints[].oauth2.clientId.configMap +Description:: ++ +-- +ConfigMap containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.endpoints[].oauth2.clientId.secret +Description:: ++ +-- +Secret containing data to use for the targets. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.endpoints[].oauth2.clientSecret +Description:: ++ +-- +The secret containing the OAuth2 client secret +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.endpoints[].params Description:: + -- @@ -402,7 +646,7 @@ Type:: -..spec.endpoints[].relabelings +=== .spec.endpoints[].relabelings Description:: + -- @@ -415,7 +659,7 @@ Type:: -..spec.endpoints[].relabelings[] +=== .spec.endpoints[].relabelings[] Description:: + -- @@ -461,7 +705,7 @@ Type:: | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. |=== -..spec.endpoints[].tlsConfig +=== .spec.endpoints[].tlsConfig Description:: + -- @@ -511,7 +755,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.endpoints[].tlsConfig.ca +=== .spec.endpoints[].tlsConfig.ca Description:: + -- @@ -537,7 +781,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.endpoints[].tlsConfig.ca.configMap +=== .spec.endpoints[].tlsConfig.ca.configMap Description:: + -- @@ -569,7 +813,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.endpoints[].tlsConfig.ca.secret +=== .spec.endpoints[].tlsConfig.ca.secret Description:: + -- @@ -601,7 +845,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.endpoints[].tlsConfig.cert +=== .spec.endpoints[].tlsConfig.cert Description:: + -- @@ -627,7 +871,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.endpoints[].tlsConfig.cert.configMap +=== .spec.endpoints[].tlsConfig.cert.configMap Description:: + -- @@ -659,7 +903,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.endpoints[].tlsConfig.cert.secret +=== .spec.endpoints[].tlsConfig.cert.secret Description:: + -- @@ -691,7 +935,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.endpoints[].tlsConfig.keySecret +=== .spec.endpoints[].tlsConfig.keySecret Description:: + -- @@ -723,7 +967,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.namespaceSelector +=== .spec.namespaceSelector Description:: + -- @@ -749,7 +993,7 @@ Type:: | List of namespace names. |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -779,7 +1023,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -792,7 +1036,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -902,7 +1146,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#servicemonitorlist-monitoring-coreos-com-v1[`ServiceMonitorList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ServiceMonitorList[`ServiceMonitorList`] schema +| 401 - Unauthorized +| Empty |=== @@ -980,7 +1226,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1037,7 +1285,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#servicemonitorlist-monitoring-coreos-com-v1[`ServiceMonitorList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ServiceMonitorList[`ServiceMonitorList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1064,7 +1314,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema | |=== @@ -1073,7 +1323,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 201 - Created +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 202 - Accepted +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 401 - Unauthorized +| Empty |=== @@ -1130,7 +1386,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1139,7 +1395,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1166,7 +1426,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1193,7 +1455,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1202,7 +1464,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1229,7 +1493,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema | |=== @@ -1238,7 +1502,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor monitoring.coreos.com/v1`] +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 201 - Created +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`ServiceMonitor`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc b/rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc index 56cacff90524..ef719bf271be 100644 --- a/rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc +++ b/rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="thanosruler-monitoring-coreos-com-v1"] = ThanosRuler [monitoring.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | Most recent observed status of the ThanosRuler cluster. Read-only. Not included when requesting from the apiserver, only from the ThanosRuler Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -..spec +=== .spec Description:: + -- @@ -144,6 +146,10 @@ Type:: | `string` | Log level for ThanosRuler to be configured with. +| `minReadySeconds` +| `integer` +| Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. + | `nodeSelector` | `object (string)` | Define which Nodes the Pods are scheduled on. @@ -253,7 +259,7 @@ Type:: | Volume represents a named volume in a pod that may be accessed by any container in the pod. |=== -..spec.affinity +=== .spec.affinity Description:: + -- @@ -283,7 +289,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.affinity.nodeAffinity +=== .spec.affinity.nodeAffinity Description:: + -- @@ -313,7 +319,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -326,7 +332,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -355,7 +361,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -389,7 +395,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -402,7 +408,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -435,7 +441,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -448,7 +454,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -481,7 +487,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -509,7 +515,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -522,7 +528,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -556,7 +562,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -569,7 +575,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -602,7 +608,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -615,7 +621,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -648,7 +654,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity +=== .spec.affinity.podAffinity Description:: + -- @@ -682,7 +688,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -695,7 +701,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -724,7 +730,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -756,7 +762,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -786,7 +792,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -799,7 +805,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -832,7 +838,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -845,7 +851,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -877,7 +883,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -907,7 +913,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -920,7 +926,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -953,7 +959,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity +=== .spec.affinity.podAntiAffinity Description:: + -- @@ -987,7 +993,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1000,7 +1006,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1029,7 +1035,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -1061,7 +1067,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1091,7 +1097,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1104,7 +1110,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1137,7 +1143,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1150,7 +1156,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1182,7 +1188,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1212,7 +1218,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1225,7 +1231,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1258,7 +1264,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.alertmanagersConfig +=== .spec.alertmanagersConfig Description:: + -- @@ -1290,7 +1296,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.containers +=== .spec.containers Description:: + -- @@ -1303,7 +1309,7 @@ Type:: -..spec.containers[] +=== .spec.containers[] Description:: + -- @@ -1431,7 +1437,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.containers[].env +=== .spec.containers[].env Description:: + -- @@ -1444,7 +1450,7 @@ Type:: -..spec.containers[].env[] +=== .spec.containers[].env[] Description:: + -- @@ -1476,7 +1482,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.containers[].env[].valueFrom +=== .spec.containers[].env[].valueFrom Description:: + -- @@ -1510,7 +1516,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.containers[].env[].valueFrom.configMapKeyRef +=== .spec.containers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -1542,7 +1548,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.containers[].env[].valueFrom.fieldRef +=== .spec.containers[].env[].valueFrom.fieldRef Description:: + -- @@ -1570,7 +1576,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.containers[].env[].valueFrom.resourceFieldRef +=== .spec.containers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -1602,7 +1608,7 @@ Required:: | Required: resource to select |=== -..spec.containers[].env[].valueFrom.secretKeyRef +=== .spec.containers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -1634,7 +1640,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.containers[].envFrom +=== .spec.containers[].envFrom Description:: + -- @@ -1647,7 +1653,7 @@ Type:: -..spec.containers[].envFrom[] +=== .spec.containers[].envFrom[] Description:: + -- @@ -1677,7 +1683,7 @@ Type:: | The Secret to select from |=== -..spec.containers[].envFrom[].configMapRef +=== .spec.containers[].envFrom[].configMapRef Description:: + -- @@ -1703,7 +1709,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.containers[].envFrom[].secretRef +=== .spec.containers[].envFrom[].secretRef Description:: + -- @@ -1729,7 +1735,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.containers[].lifecycle +=== .spec.containers[].lifecycle Description:: + -- @@ -1755,7 +1761,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.containers[].lifecycle.postStart +=== .spec.containers[].lifecycle.postStart Description:: + -- @@ -1785,7 +1791,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.postStart.exec +=== .spec.containers[].lifecycle.postStart.exec Description:: + -- @@ -1807,7 +1813,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.postStart.httpGet +=== .spec.containers[].lifecycle.postStart.httpGet Description:: + -- @@ -1851,7 +1857,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -1864,7 +1870,7 @@ Type:: -..spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -1893,7 +1899,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.postStart.tcpSocket +=== .spec.containers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -1921,7 +1927,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].lifecycle.preStop +=== .spec.containers[].lifecycle.preStop Description:: + -- @@ -1951,7 +1957,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.containers[].lifecycle.preStop.exec +=== .spec.containers[].lifecycle.preStop.exec Description:: + -- @@ -1973,7 +1979,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].lifecycle.preStop.httpGet +=== .spec.containers[].lifecycle.preStop.httpGet Description:: + -- @@ -2017,7 +2023,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -2030,7 +2036,7 @@ Type:: -..spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -2059,7 +2065,7 @@ Required:: | The header field value |=== -..spec.containers[].lifecycle.preStop.tcpSocket +=== .spec.containers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -2087,7 +2093,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].livenessProbe +=== .spec.containers[].livenessProbe Description:: + -- @@ -2137,7 +2143,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].livenessProbe.exec +=== .spec.containers[].livenessProbe.exec Description:: + -- @@ -2159,7 +2165,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].livenessProbe.httpGet +=== .spec.containers[].livenessProbe.httpGet Description:: + -- @@ -2203,7 +2209,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].livenessProbe.httpGet.httpHeaders +=== .spec.containers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -2216,7 +2222,7 @@ Type:: -..spec.containers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.containers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -2245,7 +2251,7 @@ Required:: | The header field value |=== -..spec.containers[].livenessProbe.tcpSocket +=== .spec.containers[].livenessProbe.tcpSocket Description:: + -- @@ -2273,7 +2279,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].ports +=== .spec.containers[].ports Description:: + -- @@ -2286,7 +2292,7 @@ Type:: -..spec.containers[].ports[] +=== .spec.containers[].ports[] Description:: + -- @@ -2326,7 +2332,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.containers[].readinessProbe +=== .spec.containers[].readinessProbe Description:: + -- @@ -2376,7 +2382,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].readinessProbe.exec +=== .spec.containers[].readinessProbe.exec Description:: + -- @@ -2398,7 +2404,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].readinessProbe.httpGet +=== .spec.containers[].readinessProbe.httpGet Description:: + -- @@ -2442,7 +2448,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].readinessProbe.httpGet.httpHeaders +=== .spec.containers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -2455,7 +2461,7 @@ Type:: -..spec.containers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.containers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -2484,7 +2490,7 @@ Required:: | The header field value |=== -..spec.containers[].readinessProbe.tcpSocket +=== .spec.containers[].readinessProbe.tcpSocket Description:: + -- @@ -2512,7 +2518,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].resources +=== .spec.containers[].resources Description:: + -- @@ -2538,7 +2544,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.containers[].securityContext +=== .spec.containers[].securityContext Description:: + -- @@ -2596,7 +2602,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].securityContext.capabilities +=== .spec.containers[].securityContext.capabilities Description:: + -- @@ -2622,7 +2628,7 @@ Type:: | Removed capabilities |=== -..spec.containers[].securityContext.seLinuxOptions +=== .spec.containers[].securityContext.seLinuxOptions Description:: + -- @@ -2656,7 +2662,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.containers[].securityContext.windowsOptions +=== .spec.containers[].securityContext.windowsOptions Description:: + -- @@ -2686,7 +2692,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.containers[].startupProbe +=== .spec.containers[].startupProbe Description:: + -- @@ -2736,7 +2742,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.containers[].startupProbe.exec +=== .spec.containers[].startupProbe.exec Description:: + -- @@ -2758,7 +2764,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.containers[].startupProbe.httpGet +=== .spec.containers[].startupProbe.httpGet Description:: + -- @@ -2802,7 +2808,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.containers[].startupProbe.httpGet.httpHeaders +=== .spec.containers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -2815,7 +2821,7 @@ Type:: -..spec.containers[].startupProbe.httpGet.httpHeaders[] +=== .spec.containers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -2844,7 +2850,7 @@ Required:: | The header field value |=== -..spec.containers[].startupProbe.tcpSocket +=== .spec.containers[].startupProbe.tcpSocket Description:: + -- @@ -2872,7 +2878,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.containers[].volumeDevices +=== .spec.containers[].volumeDevices Description:: + -- @@ -2885,7 +2891,7 @@ Type:: -..spec.containers[].volumeDevices[] +=== .spec.containers[].volumeDevices[] Description:: + -- @@ -2914,7 +2920,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.containers[].volumeMounts +=== .spec.containers[].volumeMounts Description:: + -- @@ -2927,7 +2933,7 @@ Type:: -..spec.containers[].volumeMounts[] +=== .spec.containers[].volumeMounts[] Description:: + -- @@ -2972,7 +2978,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.grpcServerTlsConfig +=== .spec.grpcServerTlsConfig Description:: + -- @@ -3022,7 +3028,7 @@ Type:: | Used to verify the hostname for the targets. |=== -..spec.grpcServerTlsConfig.ca +=== .spec.grpcServerTlsConfig.ca Description:: + -- @@ -3048,7 +3054,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.grpcServerTlsConfig.ca.configMap +=== .spec.grpcServerTlsConfig.ca.configMap Description:: + -- @@ -3080,7 +3086,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.grpcServerTlsConfig.ca.secret +=== .spec.grpcServerTlsConfig.ca.secret Description:: + -- @@ -3112,7 +3118,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.grpcServerTlsConfig.cert +=== .spec.grpcServerTlsConfig.cert Description:: + -- @@ -3138,7 +3144,7 @@ Type:: | Secret containing data to use for the targets. |=== -..spec.grpcServerTlsConfig.cert.configMap +=== .spec.grpcServerTlsConfig.cert.configMap Description:: + -- @@ -3170,7 +3176,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.grpcServerTlsConfig.cert.secret +=== .spec.grpcServerTlsConfig.cert.secret Description:: + -- @@ -3202,7 +3208,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.grpcServerTlsConfig.keySecret +=== .spec.grpcServerTlsConfig.keySecret Description:: + -- @@ -3234,7 +3240,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.imagePullSecrets +=== .spec.imagePullSecrets Description:: + -- @@ -3247,7 +3253,7 @@ Type:: -..spec.imagePullSecrets[] +=== .spec.imagePullSecrets[] Description:: + -- @@ -3269,7 +3275,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.initContainers +=== .spec.initContainers Description:: + -- @@ -3282,7 +3288,7 @@ Type:: -..spec.initContainers[] +=== .spec.initContainers[] Description:: + -- @@ -3410,7 +3416,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.initContainers[].env +=== .spec.initContainers[].env Description:: + -- @@ -3423,7 +3429,7 @@ Type:: -..spec.initContainers[].env[] +=== .spec.initContainers[].env[] Description:: + -- @@ -3455,7 +3461,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.initContainers[].env[].valueFrom +=== .spec.initContainers[].env[].valueFrom Description:: + -- @@ -3489,7 +3495,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.initContainers[].env[].valueFrom.configMapKeyRef +=== .spec.initContainers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -3521,7 +3527,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.initContainers[].env[].valueFrom.fieldRef +=== .spec.initContainers[].env[].valueFrom.fieldRef Description:: + -- @@ -3549,7 +3555,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.initContainers[].env[].valueFrom.resourceFieldRef +=== .spec.initContainers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -3581,7 +3587,7 @@ Required:: | Required: resource to select |=== -..spec.initContainers[].env[].valueFrom.secretKeyRef +=== .spec.initContainers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -3613,7 +3619,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.initContainers[].envFrom +=== .spec.initContainers[].envFrom Description:: + -- @@ -3626,7 +3632,7 @@ Type:: -..spec.initContainers[].envFrom[] +=== .spec.initContainers[].envFrom[] Description:: + -- @@ -3656,7 +3662,7 @@ Type:: | The Secret to select from |=== -..spec.initContainers[].envFrom[].configMapRef +=== .spec.initContainers[].envFrom[].configMapRef Description:: + -- @@ -3682,7 +3688,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.initContainers[].envFrom[].secretRef +=== .spec.initContainers[].envFrom[].secretRef Description:: + -- @@ -3708,7 +3714,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.initContainers[].lifecycle +=== .spec.initContainers[].lifecycle Description:: + -- @@ -3734,7 +3740,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.initContainers[].lifecycle.postStart +=== .spec.initContainers[].lifecycle.postStart Description:: + -- @@ -3764,7 +3770,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.postStart.exec +=== .spec.initContainers[].lifecycle.postStart.exec Description:: + -- @@ -3786,7 +3792,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.postStart.httpGet +=== .spec.initContainers[].lifecycle.postStart.httpGet Description:: + -- @@ -3830,7 +3836,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -3843,7 +3849,7 @@ Type:: -..spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -3872,7 +3878,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.postStart.tcpSocket +=== .spec.initContainers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -3900,7 +3906,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].lifecycle.preStop +=== .spec.initContainers[].lifecycle.preStop Description:: + -- @@ -3930,7 +3936,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.initContainers[].lifecycle.preStop.exec +=== .spec.initContainers[].lifecycle.preStop.exec Description:: + -- @@ -3952,7 +3958,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].lifecycle.preStop.httpGet +=== .spec.initContainers[].lifecycle.preStop.httpGet Description:: + -- @@ -3996,7 +4002,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -4009,7 +4015,7 @@ Type:: -..spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -4038,7 +4044,7 @@ Required:: | The header field value |=== -..spec.initContainers[].lifecycle.preStop.tcpSocket +=== .spec.initContainers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -4066,7 +4072,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].livenessProbe +=== .spec.initContainers[].livenessProbe Description:: + -- @@ -4116,7 +4122,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].livenessProbe.exec +=== .spec.initContainers[].livenessProbe.exec Description:: + -- @@ -4138,7 +4144,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].livenessProbe.httpGet +=== .spec.initContainers[].livenessProbe.httpGet Description:: + -- @@ -4182,7 +4188,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].livenessProbe.httpGet.httpHeaders +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -4195,7 +4201,7 @@ Type:: -..spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4224,7 +4230,7 @@ Required:: | The header field value |=== -..spec.initContainers[].livenessProbe.tcpSocket +=== .spec.initContainers[].livenessProbe.tcpSocket Description:: + -- @@ -4252,7 +4258,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].ports +=== .spec.initContainers[].ports Description:: + -- @@ -4265,7 +4271,7 @@ Type:: -..spec.initContainers[].ports[] +=== .spec.initContainers[].ports[] Description:: + -- @@ -4305,7 +4311,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.initContainers[].readinessProbe +=== .spec.initContainers[].readinessProbe Description:: + -- @@ -4355,7 +4361,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].readinessProbe.exec +=== .spec.initContainers[].readinessProbe.exec Description:: + -- @@ -4377,7 +4383,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].readinessProbe.httpGet +=== .spec.initContainers[].readinessProbe.httpGet Description:: + -- @@ -4421,7 +4427,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].readinessProbe.httpGet.httpHeaders +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -4434,7 +4440,7 @@ Type:: -..spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4463,7 +4469,7 @@ Required:: | The header field value |=== -..spec.initContainers[].readinessProbe.tcpSocket +=== .spec.initContainers[].readinessProbe.tcpSocket Description:: + -- @@ -4491,7 +4497,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].resources +=== .spec.initContainers[].resources Description:: + -- @@ -4517,7 +4523,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.initContainers[].securityContext +=== .spec.initContainers[].securityContext Description:: + -- @@ -4575,7 +4581,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].securityContext.capabilities +=== .spec.initContainers[].securityContext.capabilities Description:: + -- @@ -4601,7 +4607,7 @@ Type:: | Removed capabilities |=== -..spec.initContainers[].securityContext.seLinuxOptions +=== .spec.initContainers[].securityContext.seLinuxOptions Description:: + -- @@ -4635,7 +4641,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.initContainers[].securityContext.windowsOptions +=== .spec.initContainers[].securityContext.windowsOptions Description:: + -- @@ -4665,7 +4671,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.initContainers[].startupProbe +=== .spec.initContainers[].startupProbe Description:: + -- @@ -4715,7 +4721,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.initContainers[].startupProbe.exec +=== .spec.initContainers[].startupProbe.exec Description:: + -- @@ -4737,7 +4743,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.initContainers[].startupProbe.httpGet +=== .spec.initContainers[].startupProbe.httpGet Description:: + -- @@ -4781,7 +4787,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.initContainers[].startupProbe.httpGet.httpHeaders +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -4794,7 +4800,7 @@ Type:: -..spec.initContainers[].startupProbe.httpGet.httpHeaders[] +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -4823,7 +4829,7 @@ Required:: | The header field value |=== -..spec.initContainers[].startupProbe.tcpSocket +=== .spec.initContainers[].startupProbe.tcpSocket Description:: + -- @@ -4851,7 +4857,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.initContainers[].volumeDevices +=== .spec.initContainers[].volumeDevices Description:: + -- @@ -4864,7 +4870,7 @@ Type:: -..spec.initContainers[].volumeDevices[] +=== .spec.initContainers[].volumeDevices[] Description:: + -- @@ -4893,7 +4899,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.initContainers[].volumeMounts +=== .spec.initContainers[].volumeMounts Description:: + -- @@ -4906,7 +4912,7 @@ Type:: -..spec.initContainers[].volumeMounts[] +=== .spec.initContainers[].volumeMounts[] Description:: + -- @@ -4951,7 +4957,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.objectStorageConfig +=== .spec.objectStorageConfig Description:: + -- @@ -4983,7 +4989,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.podMetadata +=== .spec.podMetadata Description:: + -- @@ -5013,7 +5019,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.prometheusRulesExcludedFromEnforce +=== .spec.prometheusRulesExcludedFromEnforce Description:: + -- @@ -5026,7 +5032,7 @@ Type:: -..spec.prometheusRulesExcludedFromEnforce[] +=== .spec.prometheusRulesExcludedFromEnforce[] Description:: + -- @@ -5055,7 +5061,7 @@ Required:: | RuleNamespace - namespace of excluded rule |=== -..spec.queryConfig +=== .spec.queryConfig Description:: + -- @@ -5087,7 +5093,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.resources +=== .spec.resources Description:: + -- @@ -5113,7 +5119,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.ruleNamespaceSelector +=== .spec.ruleNamespaceSelector Description:: + -- @@ -5143,7 +5149,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.ruleNamespaceSelector.matchExpressions +=== .spec.ruleNamespaceSelector.matchExpressions Description:: + -- @@ -5156,7 +5162,7 @@ Type:: -..spec.ruleNamespaceSelector.matchExpressions[] +=== .spec.ruleNamespaceSelector.matchExpressions[] Description:: + -- @@ -5189,7 +5195,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.ruleSelector +=== .spec.ruleSelector Description:: + -- @@ -5219,7 +5225,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.ruleSelector.matchExpressions +=== .spec.ruleSelector.matchExpressions Description:: + -- @@ -5232,7 +5238,7 @@ Type:: -..spec.ruleSelector.matchExpressions[] +=== .spec.ruleSelector.matchExpressions[] Description:: + -- @@ -5265,7 +5271,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.securityContext +=== .spec.securityContext Description:: + -- @@ -5325,7 +5331,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.securityContext.seLinuxOptions +=== .spec.securityContext.seLinuxOptions Description:: + -- @@ -5359,7 +5365,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.securityContext.sysctls +=== .spec.securityContext.sysctls Description:: + -- @@ -5372,7 +5378,7 @@ Type:: -..spec.securityContext.sysctls[] +=== .spec.securityContext.sysctls[] Description:: + -- @@ -5401,7 +5407,7 @@ Required:: | Value of a property to set |=== -..spec.securityContext.windowsOptions +=== .spec.securityContext.windowsOptions Description:: + -- @@ -5431,7 +5437,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.storage +=== .spec.storage Description:: + -- @@ -5461,7 +5467,7 @@ Type:: | A PVC spec to be used by the Prometheus StatefulSets. |=== -..spec.storage.emptyDir +=== .spec.storage.emptyDir Description:: + -- @@ -5487,7 +5493,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.storage.volumeClaimTemplate +=== .spec.storage.volumeClaimTemplate Description:: + -- @@ -5525,7 +5531,7 @@ Type:: | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |=== -..spec.storage.volumeClaimTemplate.metadata +=== .spec.storage.volumeClaimTemplate.metadata Description:: + -- @@ -5555,7 +5561,7 @@ Type:: | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |=== -..spec.storage.volumeClaimTemplate.spec +=== .spec.storage.volumeClaimTemplate.spec Description:: + -- @@ -5601,7 +5607,7 @@ Type:: | VolumeName is the binding reference to the PersistentVolume backing this claim. |=== -..spec.storage.volumeClaimTemplate.spec.dataSource +=== .spec.storage.volumeClaimTemplate.spec.dataSource Description:: + -- @@ -5634,7 +5640,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.storage.volumeClaimTemplate.spec.resources +=== .spec.storage.volumeClaimTemplate.spec.resources Description:: + -- @@ -5660,7 +5666,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |=== -..spec.storage.volumeClaimTemplate.spec.selector +=== .spec.storage.volumeClaimTemplate.spec.selector Description:: + -- @@ -5690,7 +5696,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions Description:: + -- @@ -5703,7 +5709,7 @@ Type:: -..spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] +=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[] Description:: + -- @@ -5736,7 +5742,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.storage.volumeClaimTemplate.status +=== .spec.storage.volumeClaimTemplate.status Description:: + -- @@ -5774,7 +5780,7 @@ Type:: | Phase represents the current phase of PersistentVolumeClaim. |=== -..spec.storage.volumeClaimTemplate.status.conditions +=== .spec.storage.volumeClaimTemplate.status.conditions Description:: + -- @@ -5787,7 +5793,7 @@ Type:: -..spec.storage.volumeClaimTemplate.status.conditions[] +=== .spec.storage.volumeClaimTemplate.status.conditions[] Description:: + -- @@ -5832,7 +5838,7 @@ Required:: | PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type |=== -..spec.tolerations +=== .spec.tolerations Description:: + -- @@ -5845,7 +5851,7 @@ Type:: -..spec.tolerations[] +=== .spec.tolerations[] Description:: + -- @@ -5883,7 +5889,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.topologySpreadConstraints +=== .spec.topologySpreadConstraints Description:: + -- @@ -5896,7 +5902,7 @@ Type:: -..spec.topologySpreadConstraints[] +=== .spec.topologySpreadConstraints[] Description:: + -- @@ -5934,7 +5940,7 @@ Required:: | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. |=== -..spec.topologySpreadConstraints[].labelSelector +=== .spec.topologySpreadConstraints[].labelSelector Description:: + -- @@ -5964,7 +5970,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.topologySpreadConstraints[].labelSelector.matchExpressions +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions Description:: + -- @@ -5977,7 +5983,7 @@ Type:: -..spec.topologySpreadConstraints[].labelSelector.matchExpressions[] +=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Description:: + -- @@ -6010,7 +6016,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.tracingConfig +=== .spec.tracingConfig Description:: + -- @@ -6042,7 +6048,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.volumes +=== .spec.volumes Description:: + -- @@ -6055,7 +6061,7 @@ Type:: -..spec.volumes[] +=== .spec.volumes[] Description:: + -- @@ -6191,7 +6197,7 @@ Required:: | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -..spec.volumes[].awsElasticBlockStore +=== .spec.volumes[].awsElasticBlockStore Description:: + -- @@ -6227,7 +6233,7 @@ Required:: | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |=== -..spec.volumes[].azureDisk +=== .spec.volumes[].azureDisk Description:: + -- @@ -6272,7 +6278,7 @@ Required:: | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |=== -..spec.volumes[].azureFile +=== .spec.volumes[].azureFile Description:: + -- @@ -6305,7 +6311,7 @@ Required:: | Share Name |=== -..spec.volumes[].cephfs +=== .spec.volumes[].cephfs Description:: + -- @@ -6349,7 +6355,7 @@ Required:: | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |=== -..spec.volumes[].cephfs.secretRef +=== .spec.volumes[].cephfs.secretRef Description:: + -- @@ -6371,7 +6377,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].cinder +=== .spec.volumes[].cinder Description:: + -- @@ -6407,7 +6413,7 @@ Required:: | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |=== -..spec.volumes[].cinder.secretRef +=== .spec.volumes[].cinder.secretRef Description:: + -- @@ -6429,7 +6435,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].configMap +=== .spec.volumes[].configMap Description:: + -- @@ -6467,7 +6473,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].configMap.items +=== .spec.volumes[].configMap.items Description:: + -- @@ -6480,7 +6486,7 @@ Type:: -..spec.volumes[].configMap.items[] +=== .spec.volumes[].configMap.items[] Description:: + -- @@ -6513,7 +6519,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].csi +=== .spec.volumes[].csi Description:: + -- @@ -6553,7 +6559,7 @@ Required:: | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. |=== -..spec.volumes[].csi.nodePublishSecretRef +=== .spec.volumes[].csi.nodePublishSecretRef Description:: + -- @@ -6575,7 +6581,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].downwardAPI +=== .spec.volumes[].downwardAPI Description:: + -- @@ -6605,7 +6611,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].downwardAPI.items +=== .spec.volumes[].downwardAPI.items Description:: + -- @@ -6618,7 +6624,7 @@ Type:: -..spec.volumes[].downwardAPI.items[] +=== .spec.volumes[].downwardAPI.items[] Description:: + -- @@ -6654,7 +6660,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].downwardAPI.items[].fieldRef +=== .spec.volumes[].downwardAPI.items[].fieldRef Description:: + -- @@ -6682,7 +6688,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -6714,7 +6720,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].emptyDir +=== .spec.volumes[].emptyDir Description:: + -- @@ -6740,7 +6746,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.volumes[].fc +=== .spec.volumes[].fc Description:: + -- @@ -6778,7 +6784,7 @@ Type:: | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |=== -..spec.volumes[].flexVolume +=== .spec.volumes[].flexVolume Description:: + -- @@ -6818,7 +6824,7 @@ Required:: | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |=== -..spec.volumes[].flexVolume.secretRef +=== .spec.volumes[].flexVolume.secretRef Description:: + -- @@ -6840,7 +6846,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].flocker +=== .spec.volumes[].flocker Description:: + -- @@ -6866,7 +6872,7 @@ Type:: | UUID of the dataset. This is unique identifier of a Flocker dataset |=== -..spec.volumes[].gcePersistentDisk +=== .spec.volumes[].gcePersistentDisk Description:: + -- @@ -6902,7 +6908,7 @@ Required:: | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |=== -..spec.volumes[].gitRepo +=== .spec.volumes[].gitRepo Description:: + -- @@ -6934,7 +6940,7 @@ Required:: | Commit hash for the specified revision. |=== -..spec.volumes[].glusterfs +=== .spec.volumes[].glusterfs Description:: + -- @@ -6967,7 +6973,7 @@ Required:: | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |=== -..spec.volumes[].hostPath +=== .spec.volumes[].hostPath Description:: + -- @@ -6995,7 +7001,7 @@ Required:: | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |=== -..spec.volumes[].iscsi +=== .spec.volumes[].iscsi Description:: + -- @@ -7061,7 +7067,7 @@ Required:: | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |=== -..spec.volumes[].iscsi.secretRef +=== .spec.volumes[].iscsi.secretRef Description:: + -- @@ -7083,7 +7089,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].nfs +=== .spec.volumes[].nfs Description:: + -- @@ -7116,7 +7122,7 @@ Required:: | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |=== -..spec.volumes[].persistentVolumeClaim +=== .spec.volumes[].persistentVolumeClaim Description:: + -- @@ -7144,7 +7150,7 @@ Required:: | Will force the ReadOnly setting in VolumeMounts. Default false. |=== -..spec.volumes[].photonPersistentDisk +=== .spec.volumes[].photonPersistentDisk Description:: + -- @@ -7172,7 +7178,7 @@ Required:: | ID that identifies Photon Controller persistent disk |=== -..spec.volumes[].portworxVolume +=== .spec.volumes[].portworxVolume Description:: + -- @@ -7204,7 +7210,7 @@ Required:: | VolumeID uniquely identifies a Portworx volume |=== -..spec.volumes[].projected +=== .spec.volumes[].projected Description:: + -- @@ -7236,7 +7242,7 @@ Required:: | Projection that may be projected along with other supported volume types |=== -..spec.volumes[].projected.sources +=== .spec.volumes[].projected.sources Description:: + -- @@ -7249,7 +7255,7 @@ Type:: -..spec.volumes[].projected.sources[] +=== .spec.volumes[].projected.sources[] Description:: + -- @@ -7283,7 +7289,7 @@ Type:: | information about the serviceAccountToken data to project |=== -..spec.volumes[].projected.sources[].configMap +=== .spec.volumes[].projected.sources[].configMap Description:: + -- @@ -7317,7 +7323,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.volumes[].projected.sources[].configMap.items +=== .spec.volumes[].projected.sources[].configMap.items Description:: + -- @@ -7330,7 +7336,7 @@ Type:: -..spec.volumes[].projected.sources[].configMap.items[] +=== .spec.volumes[].projected.sources[].configMap.items[] Description:: + -- @@ -7363,7 +7369,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].downwardAPI +=== .spec.volumes[].projected.sources[].downwardAPI Description:: + -- @@ -7389,7 +7395,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.volumes[].projected.sources[].downwardAPI.items +=== .spec.volumes[].projected.sources[].downwardAPI.items Description:: + -- @@ -7402,7 +7408,7 @@ Type:: -..spec.volumes[].projected.sources[].downwardAPI.items[] +=== .spec.volumes[].projected.sources[].downwardAPI.items[] Description:: + -- @@ -7438,7 +7444,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description:: + -- @@ -7466,7 +7472,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +=== .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -7498,7 +7504,7 @@ Required:: | Required: resource to select |=== -..spec.volumes[].projected.sources[].secret +=== .spec.volumes[].projected.sources[].secret Description:: + -- @@ -7532,7 +7538,7 @@ Type:: | Specify whether the Secret or its key must be defined |=== -..spec.volumes[].projected.sources[].secret.items +=== .spec.volumes[].projected.sources[].secret.items Description:: + -- @@ -7545,7 +7551,7 @@ Type:: -..spec.volumes[].projected.sources[].secret.items[] +=== .spec.volumes[].projected.sources[].secret.items[] Description:: + -- @@ -7578,7 +7584,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].projected.sources[].serviceAccountToken +=== .spec.volumes[].projected.sources[].serviceAccountToken Description:: + -- @@ -7610,7 +7616,7 @@ Required:: | Path is the path relative to the mount point of the file to project the token into. |=== -..spec.volumes[].quobyte +=== .spec.volumes[].quobyte Description:: + -- @@ -7655,7 +7661,7 @@ Required:: | Volume is a string that references an already created Quobyte volume by name. |=== -..spec.volumes[].rbd +=== .spec.volumes[].rbd Description:: + -- @@ -7708,7 +7714,7 @@ Required:: | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |=== -..spec.volumes[].rbd.secretRef +=== .spec.volumes[].rbd.secretRef Description:: + -- @@ -7730,7 +7736,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].scaleIO +=== .spec.volumes[].scaleIO Description:: + -- @@ -7792,7 +7798,7 @@ Required:: | The name of a volume already created in the ScaleIO system that is associated with this volume source. |=== -..spec.volumes[].scaleIO.secretRef +=== .spec.volumes[].scaleIO.secretRef Description:: + -- @@ -7814,7 +7820,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].secret +=== .spec.volumes[].secret Description:: + -- @@ -7852,7 +7858,7 @@ Type:: | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -..spec.volumes[].secret.items +=== .spec.volumes[].secret.items Description:: + -- @@ -7865,7 +7871,7 @@ Type:: -..spec.volumes[].secret.items[] +=== .spec.volumes[].secret.items[] Description:: + -- @@ -7898,7 +7904,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.volumes[].storageos +=== .spec.volumes[].storageos Description:: + -- @@ -7936,7 +7942,7 @@ Type:: | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |=== -..spec.volumes[].storageos.secretRef +=== .spec.volumes[].storageos.secretRef Description:: + -- @@ -7958,7 +7964,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.volumes[].vsphereVolume +=== .spec.volumes[].vsphereVolume Description:: + -- @@ -7994,7 +8000,7 @@ Required:: | Path that identifies vSphere volume vmdk |=== -..status +=== .status Description:: + -- @@ -8115,7 +8121,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#thanosrulerlist-monitoring-coreos-com-v1[`ThanosRulerList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ThanosRulerList[`ThanosRulerList`] schema +| 401 - Unauthorized +| Empty |=== @@ -8193,7 +8201,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8250,7 +8260,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#thanosrulerlist-monitoring-coreos-com-v1[`ThanosRulerList monitoring.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.monitoring.v1.ThanosRulerList[`ThanosRulerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8277,7 +8289,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema | |=== @@ -8286,7 +8298,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 201 - Created +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 202 - Accepted +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 401 - Unauthorized +| Empty |=== @@ -8343,7 +8361,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -8352,7 +8370,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8379,7 +8401,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8406,7 +8430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -8415,7 +8439,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -8442,7 +8468,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema | |=== @@ -8451,7 +8477,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler monitoring.coreos.com/v1`] +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 201 - Created +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/clusternetwork-network-openshift-io-v1.adoc b/rest_api/network_apis/clusternetwork-network-openshift-io-v1.adoc index e03475019ef9..a1a874603771 100644 --- a/rest_api/network_apis/clusternetwork-network-openshift-io-v1.adoc +++ b/rest_api/network_apis/clusternetwork-network-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusternetwork-network-openshift-io-v1"] = ClusterNetwork [network.openshift.io/v1] ifdef::product-title[] @@ -48,7 +50,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `mtu` @@ -72,7 +74,7 @@ Required:: | VXLANPort sets the VXLAN destination port used by the cluster. It is set by the master configuration file on startup and cannot be edited manually. Valid values for VXLANPort are integers 1-65535 inclusive and if unset defaults to 4789. Changing VXLANPort allows users to resolve issues between openshift SDN and other software trying to use the same VXLAN destination port. |=== -..clusterNetworks +=== .clusterNetworks Description:: + -- @@ -85,7 +87,7 @@ Type:: -..clusterNetworks[] +=== .clusterNetworks[] Description:: + -- @@ -196,7 +198,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -253,7 +257,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusternetworklist-network-openshift-io-v1[`ClusterNetworkList network.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.network.v1.ClusterNetworkList[`ClusterNetworkList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -280,7 +286,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema | |=== @@ -289,7 +295,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 201 - Created +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 202 - Accepted +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 401 - Unauthorized +| Empty |=== @@ -343,7 +355,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -352,7 +364,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -379,7 +395,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -406,7 +424,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -415,7 +433,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -442,7 +462,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema | |=== @@ -451,7 +471,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork network.openshift.io/v1`] +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 201 - Created +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`ClusterNetwork`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc b/rest_api/network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc index 44a37e9cfe6a..01f186704b12 100644 --- a/rest_api/network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc +++ b/rest_api/network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="egressnetworkpolicy-network-openshift-io-v1"] = EgressNetworkPolicy [network.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -43,7 +45,7 @@ Required:: | spec is the specification of the current egress network policy |=== -..spec +=== .spec Description:: + -- @@ -71,7 +73,7 @@ Required:: | EgressNetworkPolicyRule contains a single egress network policy rule |=== -..spec.egress +=== .spec.egress Description:: + -- @@ -84,7 +86,7 @@ Type:: -..spec.egress[] +=== .spec.egress[] Description:: + -- @@ -113,7 +115,7 @@ Required:: | type marks this as an "Allow" or "Deny" rule |=== -..spec.egress[].to +=== .spec.egress[].to Description:: + -- @@ -216,7 +218,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#egressnetworkpolicylist-network-openshift-io-v1[`EgressNetworkPolicyList network.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.network.v1.EgressNetworkPolicyList[`EgressNetworkPolicyList`] schema +| 401 - Unauthorized +| Empty |=== @@ -294,7 +298,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -351,7 +357,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#egressnetworkpolicylist-network-openshift-io-v1[`EgressNetworkPolicyList network.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.network.v1.EgressNetworkPolicyList[`EgressNetworkPolicyList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -378,7 +386,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema | |=== @@ -387,7 +395,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 201 - Created +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 202 - Accepted +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== @@ -444,7 +458,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -453,7 +467,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -480,7 +498,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -507,7 +527,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -516,7 +536,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -543,7 +565,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema | |=== @@ -552,7 +574,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy network.openshift.io/v1`] +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 201 - Created +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`EgressNetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc b/rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc index e0ffc435378b..ba95b3cc3dc5 100644 --- a/rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc +++ b/rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="egressrouter-network-operator-openshift-io-v1"] = EgressRouter [network.operator.openshift.io/v1] ifdef::product-title[] @@ -12,6 +14,7 @@ Description:: -- EgressRouter is a feature allowing the user to define an egress router that acts as a bridge between pods and external systems. The egress router runs a service that redirects egress traffic originating from a pod or a group of pods to a remote external system or multiple destinations as per configuration. It is consumed by the cluster-network-operator. More specifically, given an EgressRouter CR with , the CNO will create and manage: - A service called - An egress pod called - A NAD called + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). EgressRouter is a single egressrouter pod configuration object. -- @@ -37,7 +40,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -49,7 +52,7 @@ Required:: | Observed status of EgressRouter. |=== -..spec +=== .spec Description:: + -- @@ -91,7 +94,7 @@ Required:: | Redirect represents the configuration parameters specific to redirect mode. |=== -..spec.addresses +=== .spec.addresses Description:: + -- @@ -104,7 +107,7 @@ Type:: -..spec.addresses[] +=== .spec.addresses[] Description:: + -- @@ -132,7 +135,7 @@ Required:: | IP is the address to configure on the router's interface. Can be IPv4 or IPv6. |=== -..spec.networkInterface +=== .spec.networkInterface Description:: + -- @@ -154,7 +157,7 @@ Type:: | Arguments specific to the interfaceType macvlan |=== -..spec.networkInterface.macvlan +=== .spec.networkInterface.macvlan Description:: + -- @@ -182,7 +185,7 @@ Required:: | Mode depicts the mode that is used for the macvlan interface; one of Bridge\|Private\|VEPA\|Passthru. The default mode is "Bridge". |=== -..spec.redirect +=== .spec.redirect Description:: + -- @@ -212,7 +215,7 @@ Type:: | L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port. |=== -..spec.redirect.redirectRules +=== .spec.redirect.redirectRules Description:: + -- @@ -225,7 +228,7 @@ Type:: -..spec.redirect.redirectRules[] +=== .spec.redirect.redirectRules[] Description:: + -- @@ -263,7 +266,7 @@ Required:: | TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from "Port" is used. |=== -..status +=== .status Description:: + -- @@ -291,7 +294,7 @@ Required:: | EgressRouterStatusCondition represents the state of the egress router's managed and monitored components. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -304,7 +307,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -426,7 +429,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#egressrouterlist-network-operator-openshift-io-v1[`EgressRouterList network.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.network.v1.EgressRouterList[`EgressRouterList`] schema +| 401 - Unauthorized +| Empty |=== @@ -504,7 +509,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -561,7 +568,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#egressrouterlist-network-operator-openshift-io-v1[`EgressRouterList network.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.network.v1.EgressRouterList[`EgressRouterList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -588,7 +597,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema | |=== @@ -597,7 +606,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 201 - Created +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 202 - Accepted +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== @@ -654,7 +669,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -663,7 +678,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -690,7 +709,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -717,7 +738,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -726,7 +747,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -753,7 +776,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema | |=== @@ -762,7 +785,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 201 - Created +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== @@ -813,7 +840,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -840,7 +869,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -849,7 +878,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -876,7 +907,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema | |=== @@ -885,7 +916,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter network.operator.openshift.io/v1`] +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 201 - Created +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`EgressRouter`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/endpoints-v1.adoc b/rest_api/network_apis/endpoints-v1.adoc new file mode 100644 index 000000000000..8c01ee70e72a --- /dev/null +++ b/rest_api/network_apis/endpoints-v1.adoc @@ -0,0 +1,1036 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="endpoints-v1"] += Endpoints [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ] +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `subsets` +| `array` +| The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. + +| `subsets[]` +| `object` +| EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ] + +|=== +=== .subsets +Description:: ++ +-- +The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. +-- + +Type:: + `array` + + + + +=== .subsets[] +Description:: ++ +-- +EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ] +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `addresses` +| `array` +| IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. + +| `addresses[]` +| `object` +| EndpointAddress is a tuple that describes single IP address. + +| `notReadyAddresses` +| `array` +| IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. + +| `notReadyAddresses[]` +| `object` +| EndpointAddress is a tuple that describes single IP address. + +| `ports` +| `array` +| Port numbers available on the related IP addresses. + +| `ports[]` +| `object` +| EndpointPort is a tuple that describes a single port. + +|=== +=== .subsets[].addresses +Description:: ++ +-- +IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. +-- + +Type:: + `array` + + + + +=== .subsets[].addresses[] +Description:: ++ +-- +EndpointAddress is a tuple that describes single IP address. +-- + +Type:: + `object` + +Required:: + - `ip` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostname` +| `string` +| The Hostname of this endpoint + +| `ip` +| `string` +| The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. + +| `nodeName` +| `string` +| Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. + +| `targetRef` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +|=== +=== .subsets[].addresses[].targetRef +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .subsets[].notReadyAddresses +Description:: ++ +-- +IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. +-- + +Type:: + `array` + + + + +=== .subsets[].notReadyAddresses[] +Description:: ++ +-- +EndpointAddress is a tuple that describes single IP address. +-- + +Type:: + `object` + +Required:: + - `ip` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostname` +| `string` +| The Hostname of this endpoint + +| `ip` +| `string` +| The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. + +| `nodeName` +| `string` +| Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. + +| `targetRef` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +|=== +=== .subsets[].notReadyAddresses[].targetRef +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .subsets[].ports +Description:: ++ +-- +Port numbers available on the related IP addresses. +-- + +Type:: + `array` + + + + +=== .subsets[].ports[] +Description:: ++ +-- +EndpointPort is a tuple that describes a single port. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `appProtocol` +| `string` +| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. + +| `name` +| `string` +| The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. + +| `port` +| `integer` +| The port number of the endpoint. + +| `protocol` +| `string` +| The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/endpoints` +- `GET`: list or watch objects of kind Endpoints +* `/api/v1/watch/endpoints` +- `GET`: watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/endpoints` +- `DELETE`: delete collection of Endpoints +- `GET`: list or watch objects of kind Endpoints +- `POST`: create Endpoints +* `/api/v1/watch/namespaces/{namespace}/endpoints` +- `GET`: watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/endpoints/{name}` +- `DELETE`: delete Endpoints +- `GET`: read the specified Endpoints +- `PATCH`: partially update the specified Endpoints +- `PUT`: replace the specified Endpoints +* `/api/v1/watch/namespaces/{namespace}/endpoints/{name}` +- `GET`: watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/endpoints + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Endpoints + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.EndpointsList[`EndpointsList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/endpoints + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/endpoints + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.EndpointsList[`EndpointsList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 201 - Created +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 202 - Accepted +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/endpoints + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/endpoints/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Endpoints +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Endpoints + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 201 - Created +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Endpoints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 201 - Created +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`Endpoints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/endpoints/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Endpoints +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/network_apis/endpointslice-discovery-k8s-io-v1.adoc b/rest_api/network_apis/endpointslice-discovery-k8s-io-v1.adoc index 946acb0ea8d2..ab45d183e041 100644 --- a/rest_api/network_apis/endpointslice-discovery-k8s-io-v1.adoc +++ b/rest_api/network_apis/endpointslice-discovery-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="endpointslice-discovery-k8s-io-v1"] = EndpointSlice [discovery.k8s.io/v1] ifdef::product-title[] @@ -48,7 +50,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. | `ports` @@ -60,7 +62,7 @@ Required:: | EndpointPort represents a Port used by an EndpointSlice |=== -..endpoints +=== .endpoints Description:: + -- @@ -73,7 +75,7 @@ Type:: -..endpoints[] +=== .endpoints[] Description:: + -- @@ -117,7 +119,7 @@ Required:: | nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate. | `targetRef` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference[`ObjectReference`] | targetRef is a reference to a Kubernetes object that represents this endpoint. | `zone` @@ -125,7 +127,7 @@ Required:: | zone is the name of the Zone this endpoint exists in. |=== -..endpoints[].conditions +=== .endpoints[].conditions Description:: + -- @@ -155,7 +157,7 @@ Type:: | terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. |=== -..endpoints[].hints +=== .endpoints[].hints Description:: + -- @@ -181,7 +183,7 @@ Type:: | ForZone provides information about which zones should consume this endpoint. |=== -..endpoints[].hints.forZones +=== .endpoints[].hints.forZones Description:: + -- @@ -194,7 +196,7 @@ Type:: -..endpoints[].hints.forZones[] +=== .endpoints[].hints.forZones[] Description:: + -- @@ -218,7 +220,7 @@ Required:: | name represents the name of the zone. |=== -..ports +=== .ports Description:: + -- @@ -231,7 +233,7 @@ Type:: -..ports[] +=== .ports[] Description:: + -- @@ -272,15 +274,21 @@ The following API endpoints are available: * `/apis/discovery.k8s.io/v1/endpointslices` - `GET`: list or watch objects of kind EndpointSlice +* `/apis/discovery.k8s.io/v1/watch/endpointslices` +- `GET`: watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices` - `DELETE`: delete collection of EndpointSlice - `GET`: list or watch objects of kind EndpointSlice - `POST`: create an EndpointSlice +* `/apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices` +- `GET`: watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}` - `DELETE`: delete an EndpointSlice - `GET`: read the specified EndpointSlice - `PATCH`: partially update the specified EndpointSlice - `PUT`: replace the specified EndpointSlice +* `/apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices/{name}` +- `GET`: watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/discovery.k8s.io/v1/endpointslices @@ -342,7 +350,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#endpointslicelist-discovery-k8s-io-v1[`EndpointSliceList discovery.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.discovery.v1.EndpointSliceList[`EndpointSliceList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/discovery.k8s.io/v1/watch/endpointslices + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -425,7 +500,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -434,7 +509,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -491,7 +568,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#endpointslicelist-discovery-k8s-io-v1[`EndpointSliceList discovery.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.discovery.v1.EndpointSliceList[`EndpointSliceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -518,7 +597,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema | |=== @@ -527,7 +606,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 201 - Created +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 202 - Accepted +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -584,7 +742,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -593,7 +751,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -608,7 +770,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -638,7 +802,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -647,7 +811,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 201 - Created +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -674,7 +842,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema | |=== @@ -683,7 +851,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice discovery.k8s.io/v1`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 201 - Created +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`EndpointSlice`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/discovery.k8s.io/v1/watch/namespaces/{namespace}/endpointslices/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the EndpointSlice +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/hostsubnet-network-openshift-io-v1.adoc b/rest_api/network_apis/hostsubnet-network-openshift-io-v1.adoc index 502ece8dc5c0..5fc4d726f0a3 100644 --- a/rest_api/network_apis/hostsubnet-network-openshift-io-v1.adoc +++ b/rest_api/network_apis/hostsubnet-network-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="hostsubnet-network-openshift-io-v1"] = HostSubnet [network.openshift.io/v1] ifdef::product-title[] @@ -52,7 +54,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `subnet` @@ -142,7 +144,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -199,7 +203,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#hostsubnetlist-network-openshift-io-v1[`HostSubnetList network.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.network.v1.HostSubnetList[`HostSubnetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -226,7 +232,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema | |=== @@ -235,7 +241,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 201 - Created +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 202 - Accepted +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 401 - Unauthorized +| Empty |=== @@ -289,7 +301,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -298,7 +310,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -325,7 +341,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -352,7 +370,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -361,7 +379,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -388,7 +408,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema | |=== @@ -397,7 +417,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet network.openshift.io/v1`] +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 201 - Created +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`HostSubnet`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/ingress-networking-k8s-io-v1.adoc b/rest_api/network_apis/ingress-networking-k8s-io-v1.adoc index 0d3bc18c5f67..ce9065430350 100644 --- a/rest_api/network_apis/ingress-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/ingress-networking-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="ingress-networking-k8s-io-v1"] = Ingress [networking.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | IngressStatus describe the current state of the Ingress. |=== -..spec +=== .spec Description:: + -- @@ -87,7 +89,7 @@ Type:: | IngressTLS describes the transport layer security associated with an Ingress. |=== -..spec.defaultBackend +=== .spec.defaultBackend Description:: + -- @@ -105,7 +107,7 @@ Type:: | Property | Type | Description | `resource` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.TypedLocalObjectReference[`TypedLocalObjectReference`] | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". | `service` @@ -113,7 +115,7 @@ Type:: | IngressServiceBackend references a Kubernetes Service as a Backend. |=== -..spec.defaultBackend.service +=== .spec.defaultBackend.service Description:: + -- @@ -141,7 +143,7 @@ Required:: | ServiceBackendPort is the service port being referenced. |=== -..spec.defaultBackend.service.port +=== .spec.defaultBackend.service.port Description:: + -- @@ -167,7 +169,7 @@ Type:: | Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". |=== -..spec.rules +=== .spec.rules Description:: + -- @@ -180,7 +182,7 @@ Type:: -..spec.rules[] +=== .spec.rules[] Description:: + -- @@ -213,7 +215,7 @@ Host can be "precise" which is a domain name without the terminating dot of a ne | HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. |=== -..spec.rules[].http +=== .spec.rules[].http Description:: + -- @@ -241,7 +243,7 @@ Required:: | HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend. |=== -..spec.rules[].http.paths +=== .spec.rules[].http.paths Description:: + -- @@ -254,7 +256,7 @@ Type:: -..spec.rules[].http.paths[] +=== .spec.rules[].http.paths[] Description:: + -- @@ -297,7 +299,7 @@ Required:: Implementations are required to support all path types. |=== -..spec.rules[].http.paths[].backend +=== .spec.rules[].http.paths[].backend Description:: + -- @@ -315,7 +317,7 @@ Type:: | Property | Type | Description | `resource` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.TypedLocalObjectReference[`TypedLocalObjectReference`] | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". | `service` @@ -323,7 +325,7 @@ Type:: | IngressServiceBackend references a Kubernetes Service as a Backend. |=== -..spec.rules[].http.paths[].backend.service +=== .spec.rules[].http.paths[].backend.service Description:: + -- @@ -351,7 +353,7 @@ Required:: | ServiceBackendPort is the service port being referenced. |=== -..spec.rules[].http.paths[].backend.service.port +=== .spec.rules[].http.paths[].backend.service.port Description:: + -- @@ -377,7 +379,7 @@ Type:: | Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". |=== -..spec.tls +=== .spec.tls Description:: + -- @@ -390,7 +392,7 @@ Type:: -..spec.tls[] +=== .spec.tls[] Description:: + -- @@ -416,7 +418,7 @@ Type:: | SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |=== -..status +=== .status Description:: + -- @@ -434,7 +436,7 @@ Type:: | Property | Type | Description | `loadBalancer` -| xref:../objects/index.adoc#loadbalancerstatus-core-v1[`LoadBalancerStatus core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LoadBalancerStatus[`LoadBalancerStatus`] | LoadBalancer contains the current status of the load-balancer. |=== @@ -445,15 +447,21 @@ The following API endpoints are available: * `/apis/networking.k8s.io/v1/ingresses` - `GET`: list or watch objects of kind Ingress +* `/apis/networking.k8s.io/v1/watch/ingresses` +- `GET`: watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses` - `DELETE`: delete collection of Ingress - `GET`: list or watch objects of kind Ingress - `POST`: create an Ingress +* `/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses` +- `GET`: watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}` - `DELETE`: delete an Ingress - `GET`: read the specified Ingress - `PATCH`: partially update the specified Ingress - `PUT`: replace the specified Ingress +* `/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name}` +- `GET`: watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status` - `GET`: read status of the specified Ingress - `PATCH`: partially update status of the specified Ingress @@ -519,7 +527,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingresslist-networking-k8s-io-v1[`IngressList networking.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.networking.v1.IngressList[`IngressList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/ingresses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -602,7 +677,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -611,7 +686,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -668,7 +745,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingresslist-networking-k8s-io-v1[`IngressList networking.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.networking.v1.IngressList[`IngressList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -695,7 +774,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema | |=== @@ -704,7 +783,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 201 - Created +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 202 - Accepted +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -761,7 +919,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -770,7 +928,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -785,7 +947,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -815,7 +979,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -824,7 +988,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 201 - Created +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -851,7 +1019,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema | |=== @@ -860,7 +1028,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 201 - Created +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Ingress +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -899,7 +1147,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -929,7 +1179,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -938,7 +1188,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 201 - Created +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -965,7 +1219,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema | |=== @@ -974,7 +1228,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress networking.k8s.io/v1`] +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 201 - Created +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`Ingress`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/ingressclass-networking-k8s-io-v1.adoc b/rest_api/network_apis/ingressclass-networking-k8s-io-v1.adoc index 6b5d127ec89e..94d7356e409e 100644 --- a/rest_api/network_apis/ingressclass-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/ingressclass-networking-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="ingressclass-networking-k8s-io-v1"] = IngressClass [networking.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | IngressClassSpec provides information about the class of an Ingress. |=== -..spec +=== .spec Description:: + -- @@ -67,7 +69,7 @@ Type:: | IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource. |=== -..spec.parameters +=== .spec.parameters Description:: + -- @@ -117,11 +119,15 @@ The following API endpoints are available: - `DELETE`: delete collection of IngressClass - `GET`: list or watch objects of kind IngressClass - `POST`: create an IngressClass +* `/apis/networking.k8s.io/v1/watch/ingressclasses` +- `GET`: watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/networking.k8s.io/v1/ingressclasses/{name}` - `DELETE`: delete an IngressClass - `GET`: read the specified IngressClass - `PATCH`: partially update the specified IngressClass - `PUT`: replace the specified IngressClass +* `/apis/networking.k8s.io/v1/watch/ingressclasses/{name}` +- `GET`: watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/networking.k8s.io/v1/ingressclasses @@ -195,7 +201,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -204,7 +210,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -261,7 +269,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingressclasslist-networking-k8s-io-v1[`IngressClassList networking.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.networking.v1.IngressClassList[`IngressClassList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -288,7 +298,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema | |=== @@ -297,7 +307,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 201 - Created +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 202 - Accepted +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/ingressclasses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -351,7 +432,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -360,7 +441,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -375,7 +460,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -405,7 +492,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -414,7 +501,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 201 - Created +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -441,7 +532,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema | |=== @@ -450,7 +541,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass networking.k8s.io/v1`] +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 201 - Created +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`IngressClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/ingressclasses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the IngressClass +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc b/rest_api/network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc index a9b14fcfc391..2b51ab38b710 100644 --- a/rest_api/network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc +++ b/rest_api/network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="ippool-whereabouts-cni-cncf-io-v1alpha1"] = IPPool [whereabouts.cni.cncf.io/v1alpha1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | IPPoolSpec defines the desired state of IPPool |=== -..spec +=== .spec Description:: + -- @@ -74,7 +76,7 @@ Required:: | Range is a RFC 4632/4291-style string that represents an IP address and prefix length in CIDR notation |=== -..spec.allocations +=== .spec.allocations Description:: + -- @@ -87,7 +89,7 @@ Type:: -..spec.allocations{} +=== .spec.allocations{} Description:: + -- @@ -188,7 +190,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ippoollist-whereabouts-cni-cncf-io-v1alpha1[`IPPoolList whereabouts.cni.cncf.io/v1alpha1`] +| xref:../objects/index.adoc#io.cncf.cni.whereabouts.v1alpha1.IPPoolList[`IPPoolList`] schema +| 401 - Unauthorized +| Empty |=== @@ -266,7 +270,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -323,7 +329,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ippoollist-whereabouts-cni-cncf-io-v1alpha1[`IPPoolList whereabouts.cni.cncf.io/v1alpha1`] +| xref:../objects/index.adoc#io.cncf.cni.whereabouts.v1alpha1.IPPoolList[`IPPoolList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -350,7 +358,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema | |=== @@ -359,7 +367,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 201 - Created +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 202 - Accepted +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 401 - Unauthorized +| Empty |=== @@ -416,7 +430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -425,7 +439,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -452,7 +470,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -479,7 +499,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -488,7 +508,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -515,7 +537,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema | |=== @@ -524,7 +546,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool whereabouts.cni.cncf.io/v1alpha1`] +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 201 - Created +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`IPPool`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/netnamespace-network-openshift-io-v1.adoc b/rest_api/network_apis/netnamespace-network-openshift-io-v1.adoc index 29d51d9003f4..e5253189f604 100644 --- a/rest_api/network_apis/netnamespace-network-openshift-io-v1.adoc +++ b/rest_api/network_apis/netnamespace-network-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="netnamespace-network-openshift-io-v1"] = NetNamespace [network.openshift.io/v1] ifdef::product-title[] @@ -40,7 +42,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `netid` @@ -134,7 +136,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -191,7 +195,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#netnamespacelist-network-openshift-io-v1[`NetNamespaceList network.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.network.v1.NetNamespaceList[`NetNamespaceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -218,7 +224,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema | |=== @@ -227,7 +233,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 201 - Created +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 202 - Accepted +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 401 - Unauthorized +| Empty |=== @@ -281,7 +293,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -290,7 +302,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -317,7 +333,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -344,7 +362,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -353,7 +371,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -380,7 +400,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema | |=== @@ -389,7 +409,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace network.openshift.io/v1`] +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 201 - Created +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`NetNamespace`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/network-apis-index.adoc b/rest_api/network_apis/network-apis-index.adoc index b6720cfc7c5a..ca8805cd4d6a 100644 --- a/rest_api/network_apis/network-apis-index.adoc +++ b/rest_api/network_apis/network-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="network-apis"] = Network APIs ifdef::product-title[] @@ -17,7 +19,7 @@ ClusterNetwork describes the cluster network. There is normally only one object Type:: `object` -== Endpoints [core/v1] +== Endpoints [v1] Description:: + @@ -68,6 +70,7 @@ Description:: -- EgressRouter is a feature allowing the user to define an egress router that acts as a bridge between pods and external systems. The egress router runs a service that redirects egress traffic originating from a pod or a group of pods to a remote external system or multiple destinations as per configuration. It is consumed by the cluster-network-operator. More specifically, given an EgressRouter CR with , the CNO will create and manage: - A service called - An egress pod called - A NAD called + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). EgressRouter is a single egressrouter pod configuration object. -- @@ -156,7 +159,8 @@ Type:: Description:: + -- -PodNetworkConnectivityCheck +PodNetworkConnectivityCheck + Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. -- Type:: @@ -181,7 +185,7 @@ To enable HTTP/2 ALPN on a route it requires a custom (non-wildcard) certificate Type:: `object` -== Service [core/v1] +== Service [v1] Description:: + diff --git a/rest_api/network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc b/rest_api/network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc index aa9c94f8d496..14a4e52aa0b2 100644 --- a/rest_api/network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc +++ b/rest_api/network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="networkattachmentdefinition-k8s-cni-cncf-io-v1"] = NetworkAttachmentDefinition [k8s.cni.cncf.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | NetworkAttachmentDefinition spec defines the desired state of a network attachment |=== -..spec +=== .spec Description:: + -- @@ -140,7 +142,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networkattachmentdefinitionlist-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinitionList k8s.cni.cncf.io/v1`] +| xref:../objects/index.adoc#io.cncf.cni.k8s.v1.NetworkAttachmentDefinitionList[`NetworkAttachmentDefinitionList`] schema +| 401 - Unauthorized +| Empty |=== @@ -218,7 +222,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -275,7 +281,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networkattachmentdefinitionlist-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinitionList k8s.cni.cncf.io/v1`] +| xref:../objects/index.adoc#io.cncf.cni.k8s.v1.NetworkAttachmentDefinitionList[`NetworkAttachmentDefinitionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -302,7 +310,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema | |=== @@ -311,7 +319,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 201 - Created +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 202 - Accepted +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 401 - Unauthorized +| Empty |=== @@ -368,7 +382,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -377,7 +391,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -404,7 +422,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -431,7 +451,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -440,7 +460,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -467,7 +489,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema | |=== @@ -476,7 +498,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition k8s.cni.cncf.io/v1`] +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 201 - Created +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`NetworkAttachmentDefinition`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/networkpolicy-networking-k8s-io-v1.adoc b/rest_api/network_apis/networkpolicy-networking-k8s-io-v1.adoc index b3b9dbafc1df..61b99f52cc9a 100644 --- a/rest_api/network_apis/networkpolicy-networking-k8s-io-v1.adoc +++ b/rest_api/network_apis/networkpolicy-networking-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="networkpolicy-networking-k8s-io-v1"] = NetworkPolicy [networking.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -41,7 +43,7 @@ Type:: | NetworkPolicySpec provides the specification of a NetworkPolicy |=== -..spec +=== .spec Description:: + -- @@ -77,7 +79,7 @@ Required:: | NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. | `podSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. | `policyTypes` @@ -85,7 +87,7 @@ Required:: | List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 |=== -..spec.egress +=== .spec.egress Description:: + -- @@ -98,7 +100,7 @@ Type:: -..spec.egress[] +=== .spec.egress[] Description:: + -- @@ -132,7 +134,7 @@ Type:: | NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed |=== -..spec.egress[].ports +=== .spec.egress[].ports Description:: + -- @@ -145,7 +147,7 @@ Type:: -..spec.egress[].ports[] +=== .spec.egress[].ports[] Description:: + -- @@ -167,7 +169,7 @@ Type:: | If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort". | `port` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. | `protocol` @@ -175,7 +177,7 @@ Type:: | The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. |=== -..spec.egress[].to +=== .spec.egress[].to Description:: + -- @@ -188,7 +190,7 @@ Type:: -..spec.egress[].to[] +=== .spec.egress[].to[] Description:: + -- @@ -210,19 +212,19 @@ Type:: | IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. | `namespaceSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. | `podSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. |=== -..spec.egress[].to[].ipBlock +=== .spec.egress[].to[].ipBlock Description:: + -- @@ -250,7 +252,7 @@ Required:: | Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range |=== -..spec.ingress +=== .spec.ingress Description:: + -- @@ -263,7 +265,7 @@ Type:: -..spec.ingress[] +=== .spec.ingress[] Description:: + -- @@ -297,7 +299,7 @@ Type:: | NetworkPolicyPort describes a port to allow traffic on |=== -..spec.ingress[].from +=== .spec.ingress[].from Description:: + -- @@ -310,7 +312,7 @@ Type:: -..spec.ingress[].from[] +=== .spec.ingress[].from[] Description:: + -- @@ -332,19 +334,19 @@ Type:: | IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. | `namespaceSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. | `podSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. |=== -..spec.ingress[].from[].ipBlock +=== .spec.ingress[].from[].ipBlock Description:: + -- @@ -372,7 +374,7 @@ Required:: | Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range |=== -..spec.ingress[].ports +=== .spec.ingress[].ports Description:: + -- @@ -385,7 +387,7 @@ Type:: -..spec.ingress[].ports[] +=== .spec.ingress[].ports[] Description:: + -- @@ -407,7 +409,7 @@ Type:: | If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort". | `port` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. | `protocol` @@ -422,15 +424,21 @@ The following API endpoints are available: * `/apis/networking.k8s.io/v1/networkpolicies` - `GET`: list or watch objects of kind NetworkPolicy +* `/apis/networking.k8s.io/v1/watch/networkpolicies` +- `GET`: watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies` - `DELETE`: delete collection of NetworkPolicy - `GET`: list or watch objects of kind NetworkPolicy - `POST`: create a NetworkPolicy +* `/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies` +- `GET`: watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}` - `DELETE`: delete a NetworkPolicy - `GET`: read the specified NetworkPolicy - `PATCH`: partially update the specified NetworkPolicy - `PUT`: replace the specified NetworkPolicy +* `/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}` +- `GET`: watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/networking.k8s.io/v1/networkpolicies @@ -492,7 +500,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networkpolicylist-networking-k8s-io-v1[`NetworkPolicyList networking.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.networking.v1.NetworkPolicyList[`NetworkPolicyList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/networkpolicies + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -575,7 +650,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -584,7 +659,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -641,7 +718,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networkpolicylist-networking-k8s-io-v1[`NetworkPolicyList networking.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.networking.v1.NetworkPolicyList[`NetworkPolicyList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -668,7 +747,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema | |=== @@ -677,7 +756,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 201 - Created +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 202 - Accepted +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -734,7 +892,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -743,7 +901,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -758,7 +920,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -788,7 +952,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -797,7 +961,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 201 - Created +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -824,7 +992,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema | |=== @@ -833,7 +1001,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy networking.k8s.io/v1`] +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 201 - Created +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`NetworkPolicy`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the NetworkPolicy +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc b/rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc index 6b9c15dd74e9..51c11547b9d6 100644 --- a/rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc +++ b/rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1"] = PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1] ifdef::product-title[] @@ -10,7 +12,8 @@ toc::[] Description:: + -- -PodNetworkConnectivityCheck +PodNetworkConnectivityCheck + Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. -- Type:: @@ -35,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +50,7 @@ Required:: | Status contains the observed status of the connectivity check |=== -..spec +=== .spec Description:: + -- @@ -80,7 +83,7 @@ Required:: | TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource. |=== -..spec.tlsClientCert +=== .spec.tlsClientCert Description:: + -- @@ -104,7 +107,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..status +=== .status Description:: + -- @@ -154,7 +157,7 @@ Type:: | LogEntry records events |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -167,7 +170,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -208,7 +211,7 @@ Required:: | Type of the condition |=== -..status.failures +=== .status.failures Description:: + -- @@ -221,7 +224,7 @@ Type:: -..status.failures[] +=== .status.failures[] Description:: + -- @@ -261,7 +264,7 @@ Required:: | Start time of check action. |=== -..status.outages +=== .status.outages Description:: + -- @@ -274,7 +277,7 @@ Type:: -..status.outages[] +=== .status.outages[] Description:: + -- @@ -320,7 +323,7 @@ Type:: | LogEntry records events |=== -..status.outages[].endLogs +=== .status.outages[].endLogs Description:: + -- @@ -333,7 +336,7 @@ Type:: -..status.outages[].endLogs[] +=== .status.outages[].endLogs[] Description:: + -- @@ -373,7 +376,7 @@ Required:: | Start time of check action. |=== -..status.outages[].startLogs +=== .status.outages[].startLogs Description:: + -- @@ -386,7 +389,7 @@ Type:: -..status.outages[].startLogs[] +=== .status.outages[].startLogs[] Description:: + -- @@ -426,7 +429,7 @@ Required:: | Start time of check action. |=== -..status.successes +=== .status.successes Description:: + -- @@ -439,7 +442,7 @@ Type:: -..status.successes[] +=== .status.successes[] Description:: + -- @@ -560,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#podnetworkconnectivitychecklist-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheckList controlplane.operator.openshift.io/v1alpha1`] +| xref:../objects/index.adoc#io.openshift.operator.controlplane.v1alpha1.PodNetworkConnectivityCheckList[`PodNetworkConnectivityCheckList`] schema +| 401 - Unauthorized +| Empty |=== @@ -638,7 +643,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -695,7 +702,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#podnetworkconnectivitychecklist-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheckList controlplane.operator.openshift.io/v1alpha1`] +| xref:../objects/index.adoc#io.openshift.operator.controlplane.v1alpha1.PodNetworkConnectivityCheckList[`PodNetworkConnectivityCheckList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -722,7 +731,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema | |=== @@ -731,7 +740,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 201 - Created +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 202 - Accepted +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== @@ -788,7 +803,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -797,7 +812,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -824,7 +843,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -851,7 +872,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -860,7 +881,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -887,7 +910,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema | |=== @@ -896,7 +919,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 201 - Created +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== @@ -947,7 +974,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -974,7 +1003,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -983,7 +1012,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1010,7 +1041,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema | |=== @@ -1019,7 +1050,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1`] +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 201 - Created +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`PodNetworkConnectivityCheck`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/route-route-openshift-io-v1.adoc b/rest_api/network_apis/route-route-openshift-io-v1.adoc index 69910b93868d..cd2275213b2c 100644 --- a/rest_api/network_apis/route-route-openshift-io-v1.adoc +++ b/rest_api/network_apis/route-route-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="route-route-openshift-io-v1"] = Route [route.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -57,7 +59,7 @@ The `tls` field is optional and allows specific certificates or behavior for the | RouteStatus provides relevant info about the status of a route, including which routers acknowledge it. |=== -..spec +=== .spec Description:: + -- @@ -117,7 +119,7 @@ Example: subdomain `frontend` automatically receives the router subdomain `apps. | Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed. |=== -..spec.alternateBackends +=== .spec.alternateBackends Description:: + -- @@ -130,7 +132,7 @@ Type:: -..spec.alternateBackends[] +=== .spec.alternateBackends[] Description:: + -- @@ -163,7 +165,7 @@ Required:: | weight as an integer between 0 and 256, default 100, that specifies the target's relative weight against other target reference objects. 0 suppresses requests to this backend. |=== -..spec.port +=== .spec.port Description:: + -- @@ -183,11 +185,11 @@ Required:: | Property | Type | Description | `targetPort` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required |=== -..spec.tls +=== .spec.tls Description:: + -- @@ -235,7 +237,7 @@ Required:: * edge - TLS termination is done by the router and http is used to communicate with the backend (default) * passthrough - Traffic is sent straight to the destination without the router providing TLS termination * reencrypt - TLS termination is done by the router and https is used to communicate with the backend |=== -..spec.to +=== .spec.to Description:: + -- @@ -268,7 +270,7 @@ Required:: | weight as an integer between 0 and 256, default 100, that specifies the target's relative weight against other target reference objects. 0 suppresses requests to this backend. |=== -..status +=== .status Description:: + -- @@ -294,7 +296,7 @@ Type:: | RouteIngress holds information about the places where a route is exposed. |=== -..status.ingress +=== .status.ingress Description:: + -- @@ -307,7 +309,7 @@ Type:: -..status.ingress[] +=== .status.ingress[] Description:: + -- @@ -349,7 +351,7 @@ Type:: | Wildcard policy is the wildcard policy that was allowed where this route is exposed. |=== -..status.ingress[].conditions +=== .status.ingress[].conditions Description:: + -- @@ -362,7 +364,7 @@ Type:: -..status.ingress[].conditions[] +=== .status.ingress[].conditions[] Description:: + -- @@ -383,7 +385,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | RFC 3339 date and time when this condition last transitioned | `message` @@ -410,15 +412,21 @@ The following API endpoints are available: * `/apis/route.openshift.io/v1/routes` - `GET`: list or watch objects of kind Route +* `/apis/route.openshift.io/v1/watch/routes` +- `GET`: watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/route.openshift.io/v1/namespaces/{namespace}/routes` - `DELETE`: delete collection of Route - `GET`: list or watch objects of kind Route - `POST`: create a Route +* `/apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes` +- `GET`: watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}` - `DELETE`: delete a Route - `GET`: read the specified Route - `PATCH`: partially update the specified Route - `PUT`: replace the specified Route +* `/apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name}` +- `GET`: watch changes to an object of kind Route. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status` - `GET`: read status of the specified Route - `PATCH`: partially update status of the specified Route @@ -484,7 +492,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#routelist-route-openshift-io-v1[`RouteList route.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.route.v1.RouteList[`RouteList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/routes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -567,7 +642,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -576,7 +651,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -633,7 +710,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#routelist-route-openshift-io-v1[`RouteList route.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.route.v1.RouteList[`RouteList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -660,7 +739,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema | |=== @@ -669,7 +748,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 202 - Accepted +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -726,7 +884,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -735,7 +893,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -750,7 +912,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -780,7 +944,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -789,7 +953,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -816,7 +982,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema | |=== @@ -825,7 +991,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Route +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Route. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -864,7 +1110,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -894,7 +1142,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -903,7 +1151,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -930,7 +1180,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema | |=== @@ -939,7 +1189,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route route.openshift.io/v1`] +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/network_apis/service-v1.adoc b/rest_api/network_apis/service-v1.adoc new file mode 100644 index 000000000000..1860accaa4d3 --- /dev/null +++ b/rest_api/network_apis/service-v1.adoc @@ -0,0 +1,1122 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="service-v1"] += Service [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| ServiceSpec describes the attributes that a user creates on a service. + +| `status` +| `object` +| ServiceStatus represents the current status of a service. + +|=== +=== .spec +Description:: ++ +-- +ServiceSpec describes the attributes that a user creates on a service. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allocateLoadBalancerNodePorts` +| `boolean` +| allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is beta-level and is only honored by servers that enable the ServiceLBNodePortControl feature. + +| `clusterIP` +| `string` +| clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +| `clusterIPs` +| `array (string)` +| ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. + +Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +| `externalIPs` +| `array (string)` +| externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. + +| `externalName` +| `string` +| externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". + +| `externalTrafficPolicy` +| `string` +| externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. + +| `healthCheckNodePort` +| `integer` +| healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). + +| `internalTrafficPolicy` +| `string` +| InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster". + +| `ipFamilies` +| `array (string)` +| IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. + +This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. + +| `ipFamilyPolicy` +| `string` +| IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. + +| `loadBalancerClass` +| `string` +| loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. + +| `loadBalancerIP` +| `string` +| Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. + +| `loadBalancerSourceRanges` +| `array (string)` +| If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ + +| `ports` +| `array` +| The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +| `ports[]` +| `object` +| ServicePort contains information on service's port. + +| `publishNotReadyAddresses` +| `boolean` +| publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. + +| `selector` +| `object (string)` +| Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ + +| `sessionAffinity` +| `string` +| Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +| `sessionAffinityConfig` +| `object` +| SessionAffinityConfig represents the configurations of session affinity. + +| `type` +| `string` +| type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + +|=== +=== .spec.ports +Description:: ++ +-- +The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +-- + +Type:: + `array` + + + + +=== .spec.ports[] +Description:: ++ +-- +ServicePort contains information on service's port. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `appProtocol` +| `string` +| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. + +| `name` +| `string` +| The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. + +| `nodePort` +| `integer` +| The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + +| `port` +| `integer` +| The port that will be exposed by this service. + +| `protocol` +| `string` +| The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. + +| `targetPort` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + +|=== +=== .spec.sessionAffinityConfig +Description:: ++ +-- +SessionAffinityConfig represents the configurations of session affinity. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `clientIP` +| `object` +| ClientIPConfig represents the configurations of Client IP based session affinity. + +|=== +=== .spec.sessionAffinityConfig.clientIP +Description:: ++ +-- +ClientIPConfig represents the configurations of Client IP based session affinity. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `timeoutSeconds` +| `integer` +| timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). + +|=== +=== .status +Description:: ++ +-- +ServiceStatus represents the current status of a service. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditions` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Condition[`array (Condition)`] +| Current service state + +| `loadBalancer` +| `object` +| LoadBalancerStatus represents the status of a load-balancer. + +|=== +=== .status.loadBalancer +Description:: ++ +-- +LoadBalancerStatus represents the status of a load-balancer. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `ingress` +| `array` +| Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. + +| `ingress[]` +| `object` +| LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point. + +|=== +=== .status.loadBalancer.ingress +Description:: ++ +-- +Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. +-- + +Type:: + `array` + + + + +=== .status.loadBalancer.ingress[] +Description:: ++ +-- +LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostname` +| `string` +| Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) + +| `ip` +| `string` +| IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) + +| `ports` +| `array` +| Ports is a list of records of service ports If used, every port defined in the service should have an entry in it + +| `ports[]` +| `object` +| + +|=== +=== .status.loadBalancer.ingress[].ports +Description:: ++ +-- +Ports is a list of records of service ports If used, every port defined in the service should have an entry in it +-- + +Type:: + `array` + + + + +=== .status.loadBalancer.ingress[].ports[] +Description:: ++ +-- + +-- + +Type:: + `object` + +Required:: + - `port` + - `protocol` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `error` +| `string` +| Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use + CamelCase names +- cloud provider specific error values must have names that comply with the + format foo.example.com/CamelCase. + +| `port` +| `integer` +| Port is the port number of the service port of which status is recorded here + +| `protocol` +| `string` +| Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP" + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/services` +- `GET`: list or watch objects of kind Service +* `/api/v1/watch/services` +- `GET`: watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/services` +- `GET`: list or watch objects of kind Service +- `POST`: create a Service +* `/api/v1/watch/namespaces/{namespace}/services` +- `GET`: watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/services/{name}` +- `DELETE`: delete a Service +- `GET`: read the specified Service +- `PATCH`: partially update the specified Service +- `PUT`: replace the specified Service +* `/api/v1/watch/namespaces/{namespace}/services/{name}` +- `GET`: watch changes to an object of kind Service. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{namespace}/services/{name}/status` +- `GET`: read status of the specified Service +- `PATCH`: partially update status of the specified Service +- `PUT`: replace status of the specified Service + + +=== /api/v1/services + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Service + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ServiceList[`ServiceList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/services + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/services + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ServiceList[`ServiceList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 201 - Created +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 202 - Accepted +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/services + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/services/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Service +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Service + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 201 - Created +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 201 - Created +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/services/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Service +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Service. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/services/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Service +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified Service + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 201 - Created +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified Service + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 201 - Created +| xref:../network_apis/service-v1.adoc#service-v1[`Service`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/node_apis/node-apis-index.adoc b/rest_api/node_apis/node-apis-index.adoc index 3a8a87ceb018..b865b1e88bfe 100644 --- a/rest_api/node_apis/node-apis-index.adoc +++ b/rest_api/node_apis/node-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="node-apis"] = Node APIs ifdef::product-title[] @@ -6,7 +8,7 @@ endif::[] toc::[] -== Node [core/v1] +== Node [v1] Description:: + diff --git a/rest_api/node_apis/node-v1.adoc b/rest_api/node_apis/node-v1.adoc new file mode 100644 index 000000000000..66cbff7762ea --- /dev/null +++ b/rest_api/node_apis/node-v1.adoc @@ -0,0 +1,1450 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="node-v1"] += Node [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| NodeSpec describes the attributes that a node is created with. + +| `status` +| `object` +| NodeStatus is information about the current status of a node. + +|=== +=== .spec +Description:: ++ +-- +NodeSpec describes the attributes that a node is created with. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configSource` +| `object` +| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 + +| `externalID` +| `string` +| Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 + +| `podCIDR` +| `string` +| PodCIDR represents the pod IP range assigned to the node. + +| `podCIDRs` +| `array (string)` +| podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. + +| `providerID` +| `string` +| ID of the node assigned by the cloud provider in the format: :// + +| `taints` +| `array` +| If specified, the node's taints. + +| `taints[]` +| `object` +| The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. + +| `unschedulable` +| `boolean` +| Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration + +|=== +=== .spec.configSource +Description:: ++ +-- +NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration + +|=== +=== .spec.configSource.configMap +Description:: ++ +-- +ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration +-- + +Type:: + `object` + +Required:: + - `namespace` + - `name` + - `kubeletConfigKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kubeletConfigKey` +| `string` +| KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + +| `name` +| `string` +| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + +| `namespace` +| `string` +| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + +| `resourceVersion` +| `string` +| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +| `uid` +| `string` +| UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +|=== +=== .spec.taints +Description:: ++ +-- +If specified, the node's taints. +-- + +Type:: + `array` + + + + +=== .spec.taints[] +Description:: ++ +-- +The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. +-- + +Type:: + `object` + +Required:: + - `key` + - `effect` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `effect` +| `string` +| Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. + +| `key` +| `string` +| Required. The taint key to be applied to a node. + +| `timeAdded` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. + +| `value` +| `string` +| The taint value corresponding to the taint key. + +|=== +=== .status +Description:: ++ +-- +NodeStatus is information about the current status of a node. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `addresses` +| `array` +| List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example. + +| `addresses[]` +| `object` +| NodeAddress contains information for the node's address. + +| `allocatable` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. + +| `capacity` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity + +| `conditions` +| `array` +| Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition + +| `conditions[]` +| `object` +| NodeCondition contains condition information for a node. + +| `config` +| `object` +| NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource. + +| `daemonEndpoints` +| `object` +| NodeDaemonEndpoints lists ports opened by daemons running on the Node. + +| `images` +| `array` +| List of container images on this node + +| `images[]` +| `object` +| Describe a container image + +| `nodeInfo` +| `object` +| NodeSystemInfo is a set of ids/uuids to uniquely identify the node. + +| `phase` +| `string` +| NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. + +| `volumesAttached` +| `array` +| List of volumes that are attached to the node. + +| `volumesAttached[]` +| `object` +| AttachedVolume describes a volume attached to a node + +| `volumesInUse` +| `array (string)` +| List of attachable volumes in use (mounted) by the node. + +|=== +=== .status.addresses +Description:: ++ +-- +List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example. +-- + +Type:: + `array` + + + + +=== .status.addresses[] +Description:: ++ +-- +NodeAddress contains information for the node's address. +-- + +Type:: + `object` + +Required:: + - `type` + - `address` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `address` +| `string` +| The node address. + +| `type` +| `string` +| Node address type, one of Hostname, ExternalIP or InternalIP. + +|=== +=== .status.conditions +Description:: ++ +-- +Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +NodeCondition contains condition information for a node. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastHeartbeatTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time we got an update on a given condition. + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time the condition transit from one status to another. + +| `message` +| `string` +| Human readable message indicating details about last transition. + +| `reason` +| `string` +| (brief) reason for the condition's last transition. + +| `status` +| `string` +| Status of the condition, one of True, False, Unknown. + +| `type` +| `string` +| Type of node condition. + +|=== +=== .status.config +Description:: ++ +-- +NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `active` +| `object` +| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 + +| `assigned` +| `object` +| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 + +| `error` +| `string` +| Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions. + +| `lastKnownGood` +| `object` +| NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 + +|=== +=== .status.config.active +Description:: ++ +-- +NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration + +|=== +=== .status.config.active.configMap +Description:: ++ +-- +ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration +-- + +Type:: + `object` + +Required:: + - `namespace` + - `name` + - `kubeletConfigKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kubeletConfigKey` +| `string` +| KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + +| `name` +| `string` +| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + +| `namespace` +| `string` +| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + +| `resourceVersion` +| `string` +| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +| `uid` +| `string` +| UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +|=== +=== .status.config.assigned +Description:: ++ +-- +NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration + +|=== +=== .status.config.assigned.configMap +Description:: ++ +-- +ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration +-- + +Type:: + `object` + +Required:: + - `namespace` + - `name` + - `kubeletConfigKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kubeletConfigKey` +| `string` +| KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + +| `name` +| `string` +| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + +| `namespace` +| `string` +| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + +| `resourceVersion` +| `string` +| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +| `uid` +| `string` +| UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +|=== +=== .status.config.lastKnownGood +Description:: ++ +-- +NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration + +|=== +=== .status.config.lastKnownGood.configMap +Description:: ++ +-- +ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration +-- + +Type:: + `object` + +Required:: + - `namespace` + - `name` + - `kubeletConfigKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kubeletConfigKey` +| `string` +| KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + +| `name` +| `string` +| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + +| `namespace` +| `string` +| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + +| `resourceVersion` +| `string` +| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +| `uid` +| `string` +| UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +|=== +=== .status.daemonEndpoints +Description:: ++ +-- +NodeDaemonEndpoints lists ports opened by daemons running on the Node. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kubeletEndpoint` +| `object` +| DaemonEndpoint contains information about a single Daemon endpoint. + +|=== +=== .status.daemonEndpoints.kubeletEndpoint +Description:: ++ +-- +DaemonEndpoint contains information about a single Daemon endpoint. +-- + +Type:: + `object` + +Required:: + - `Port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `Port` +| `integer` +| Port number of the given endpoint. + +|=== +=== .status.images +Description:: ++ +-- +List of container images on this node +-- + +Type:: + `array` + + + + +=== .status.images[] +Description:: ++ +-- +Describe a container image +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `names` +| `array (string)` +| Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] + +| `sizeBytes` +| `integer` +| The size of the image in bytes. + +|=== +=== .status.nodeInfo +Description:: ++ +-- +NodeSystemInfo is a set of ids/uuids to uniquely identify the node. +-- + +Type:: + `object` + +Required:: + - `machineID` + - `systemUUID` + - `bootID` + - `kernelVersion` + - `osImage` + - `containerRuntimeVersion` + - `kubeletVersion` + - `kubeProxyVersion` + - `operatingSystem` + - `architecture` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `architecture` +| `string` +| The Architecture reported by the node + +| `bootID` +| `string` +| Boot ID reported by the node. + +| `containerRuntimeVersion` +| `string` +| ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). + +| `kernelVersion` +| `string` +| Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). + +| `kubeProxyVersion` +| `string` +| KubeProxy Version reported by the node. + +| `kubeletVersion` +| `string` +| Kubelet Version reported by the node. + +| `machineID` +| `string` +| MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html + +| `operatingSystem` +| `string` +| The Operating System reported by the node + +| `osImage` +| `string` +| OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). + +| `systemUUID` +| `string` +| SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid + +|=== +=== .status.volumesAttached +Description:: ++ +-- +List of volumes that are attached to the node. +-- + +Type:: + `array` + + + + +=== .status.volumesAttached[] +Description:: ++ +-- +AttachedVolume describes a volume attached to a node +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| DevicePath represents the device path where the volume should be available + +| `name` +| `string` +| Name of the attached volume + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/nodes` +- `DELETE`: delete collection of Node +- `GET`: list or watch objects of kind Node +- `POST`: create a Node +* `/api/v1/watch/nodes` +- `GET`: watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/nodes/{name}` +- `DELETE`: delete a Node +- `GET`: read the specified Node +- `PATCH`: partially update the specified Node +- `PUT`: replace the specified Node +* `/api/v1/watch/nodes/{name}` +- `GET`: watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/nodes/{name}/status` +- `GET`: read status of the specified Node +- `PATCH`: partially update status of the specified Node +- `PUT`: replace status of the specified Node + + +=== /api/v1/nodes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.NodeList[`NodeList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 201 - Created +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 202 - Accepted +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/nodes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/nodes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Node +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Node + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 201 - Created +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 201 - Created +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/nodes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Node +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/nodes/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Node +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified Node + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 201 - Created +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified Node + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 201 - Created +| xref:../node_apis/node-v1.adoc#node-v1[`Node`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/node_apis/profile-tuned-openshift-io-v1.adoc b/rest_api/node_apis/profile-tuned-openshift-io-v1.adoc index 95cccbbd7a02..12d7482e39be 100644 --- a/rest_api/node_apis/profile-tuned-openshift-io-v1.adoc +++ b/rest_api/node_apis/profile-tuned-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="profile-tuned-openshift-io-v1"] = Profile [tuned.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | ProfileStatus is the status for a Profile resource; the status is for internal use only and its fields may be changed/removed in the future. |=== -..spec +=== .spec Description:: + -- @@ -69,7 +71,7 @@ Required:: | |=== -..spec.config +=== .spec.config Description:: + -- @@ -97,7 +99,7 @@ Required:: | Tuned profile to apply |=== -..status +=== .status Description:: + -- @@ -137,7 +139,7 @@ Required:: | the current profile in use by the Tuned daemon |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -150,7 +152,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -269,7 +271,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#profilelist-tuned-openshift-io-v1[`ProfileList tuned.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.tuned.v1.ProfileList[`ProfileList`] schema +| 401 - Unauthorized +| Empty |=== @@ -347,7 +351,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -404,7 +410,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#profilelist-tuned-openshift-io-v1[`ProfileList tuned.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.tuned.v1.ProfileList[`ProfileList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -431,7 +439,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema | |=== @@ -440,7 +448,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 201 - Created +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 202 - Accepted +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 401 - Unauthorized +| Empty |=== @@ -497,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -506,7 +520,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -533,7 +551,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -560,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -569,7 +589,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -596,7 +618,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema | |=== @@ -605,7 +627,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile tuned.openshift.io/v1`] +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 201 - Created +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`Profile`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/node_apis/runtimeclass-node-k8s-io-v1.adoc b/rest_api/node_apis/runtimeclass-node-k8s-io-v1.adoc index 7eec322e01d8..46a5185d498b 100644 --- a/rest_api/node_apis/runtimeclass-node-k8s-io-v1.adoc +++ b/rest_api/node_apis/runtimeclass-node-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="runtimeclass-node-k8s-io-v1"] = RuntimeClass [node.k8s.io/v1] ifdef::product-title[] @@ -39,7 +41,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `overhead` @@ -51,7 +53,7 @@ Required:: | Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. |=== -..overhead +=== .overhead Description:: + -- @@ -69,11 +71,11 @@ Type:: | Property | Type | Description | `podFixed` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] | PodFixed represents the fixed resource overhead associated with running a pod. |=== -..scheduling +=== .scheduling Description:: + -- @@ -95,7 +97,7 @@ Type:: | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. | `tolerations` -| xref:../objects/index.adoc#toleration-core-v1[`array (Toleration core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.Toleration[`array (Toleration)`] | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. |=== @@ -108,11 +110,15 @@ The following API endpoints are available: - `DELETE`: delete collection of RuntimeClass - `GET`: list or watch objects of kind RuntimeClass - `POST`: create a RuntimeClass +* `/apis/node.k8s.io/v1/watch/runtimeclasses` +- `GET`: watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/node.k8s.io/v1/runtimeclasses/{name}` - `DELETE`: delete a RuntimeClass - `GET`: read the specified RuntimeClass - `PATCH`: partially update the specified RuntimeClass - `PUT`: replace the specified RuntimeClass +* `/apis/node.k8s.io/v1/watch/runtimeclasses/{name}` +- `GET`: watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/node.k8s.io/v1/runtimeclasses @@ -186,7 +192,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -195,7 +201,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -252,7 +260,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#runtimeclasslist-node-k8s-io-v1[`RuntimeClassList node.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.node.v1.RuntimeClassList[`RuntimeClassList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -279,7 +289,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema | |=== @@ -288,7 +298,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 201 - Created +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 202 - Accepted +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/node.k8s.io/v1/watch/runtimeclasses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -342,7 +423,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -351,7 +432,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -366,7 +451,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -396,7 +483,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -405,7 +492,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 201 - Created +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -432,7 +523,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema | |=== @@ -441,7 +532,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass node.k8s.io/v1`] +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 201 - Created +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`RuntimeClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/node.k8s.io/v1/watch/runtimeclasses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the RuntimeClass +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc b/rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc index 4eaa586de623..8998ec886700 100644 --- a/rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc +++ b/rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="tuned-tuned-openshift-io-v1"] = Tuned [tuned.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | TunedStatus is the status for a Tuned resource. |=== -..spec +=== .spec Description:: + -- @@ -83,7 +85,7 @@ Type:: | Selection logic for a single Tuned profile. |=== -..spec.profile +=== .spec.profile Description:: + -- @@ -96,7 +98,7 @@ Type:: -..spec.profile[] +=== .spec.profile[] Description:: + -- @@ -125,7 +127,7 @@ Required:: | Name of the Tuned profile to be used in the recommend section. |=== -..spec.recommend +=== .spec.recommend Description:: + -- @@ -138,7 +140,7 @@ Type:: -..spec.recommend[] +=== .spec.recommend[] Description:: + -- @@ -183,7 +185,7 @@ Required:: | Name of the Tuned profile to recommend. |=== -..spec.recommend[].match +=== .spec.recommend[].match Description:: + -- @@ -196,7 +198,7 @@ Type:: -..spec.recommend[].match[] +=== .spec.recommend[].match[] Description:: + -- @@ -232,7 +234,7 @@ Required:: | Node or Pod label value. If omitted, the presence of label name is enough to match. |=== -..spec.recommend[].operand +=== .spec.recommend[].operand Description:: + -- @@ -256,7 +258,7 @@ Required:: | turn debugging on/off for the Tuned daemon: true/false (default is false) |=== -..status +=== .status Description:: + -- @@ -346,7 +348,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#tunedlist-tuned-openshift-io-v1[`TunedList tuned.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.tuned.v1.TunedList[`TunedList`] schema +| 401 - Unauthorized +| Empty |=== @@ -424,7 +428,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -481,7 +487,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#tunedlist-tuned-openshift-io-v1[`TunedList tuned.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.tuned.v1.TunedList[`TunedList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -508,7 +516,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema | |=== @@ -517,7 +525,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 201 - Created +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 202 - Accepted +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 401 - Unauthorized +| Empty |=== @@ -574,7 +588,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -583,7 +597,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -610,7 +628,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -637,7 +657,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -646,7 +666,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -673,7 +695,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema | |=== @@ -682,7 +704,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned tuned.openshift.io/v1`] +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 201 - Created +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`Tuned`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/oauth_apis/oauth-apis-index.adoc b/rest_api/oauth_apis/oauth-apis-index.adoc index 10ad204f5e03..adedb396ac78 100644 --- a/rest_api/oauth_apis/oauth-apis-index.adoc +++ b/rest_api/oauth_apis/oauth-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauth-apis"] = OAuth APIs ifdef::product-title[] diff --git a/rest_api/oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc b/rest_api/oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc index a01531d3b3cd..0e9e12abbefe 100644 --- a/rest_api/oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc +++ b/rest_api/oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauthaccesstoken-oauth-openshift-io-v1"] = OAuthAccessToken [oauth.openshift.io/v1] ifdef::product-title[] @@ -49,7 +51,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `redirectURI` @@ -82,11 +84,15 @@ The following API endpoints are available: - `DELETE`: delete collection of OAuthAccessToken - `GET`: list or watch objects of kind OAuthAccessToken - `POST`: create an OAuthAccessToken +* `/apis/oauth.openshift.io/v1/watch/oauthaccesstokens` +- `GET`: watch individual changes to a list of OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/oauth.openshift.io/v1/oauthaccesstokens/{name}` - `DELETE`: delete an OAuthAccessToken - `GET`: read the specified OAuthAccessToken - `PATCH`: partially update the specified OAuthAccessToken - `PUT`: replace the specified OAuthAccessToken +* `/apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name}` +- `GET`: watch changes to an object of kind OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/oauth.openshift.io/v1/oauthaccesstokens @@ -160,7 +166,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -169,7 +175,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -226,7 +234,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#oauthaccesstokenlist-oauth-openshift-io-v1[`OAuthAccessTokenList oauth.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.oauth.v1.OAuthAccessTokenList[`OAuthAccessTokenList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -253,7 +263,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema | |=== @@ -262,7 +272,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 201 - Created +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 202 - Accepted +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthaccesstokens + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -316,7 +397,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -325,7 +406,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -340,7 +425,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -370,7 +457,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -379,7 +466,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -406,7 +495,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema | |=== @@ -415,7 +504,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 201 - Created +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`OAuthAccessToken`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthaccesstokens/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the OAuthAccessToken +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind OAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc b/rest_api/oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc index 84f332edbb5c..27dcc7ca5bd4 100644 --- a/rest_api/oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc +++ b/rest_api/oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauthauthorizetoken-oauth-openshift-io-v1"] = OAuthAuthorizeToken [oauth.openshift.io/v1] ifdef::product-title[] @@ -49,7 +51,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `redirectURI` @@ -82,11 +84,15 @@ The following API endpoints are available: - `DELETE`: delete collection of OAuthAuthorizeToken - `GET`: list or watch objects of kind OAuthAuthorizeToken - `POST`: create an OAuthAuthorizeToken +* `/apis/oauth.openshift.io/v1/watch/oauthauthorizetokens` +- `GET`: watch individual changes to a list of OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/oauth.openshift.io/v1/oauthauthorizetokens/{name}` - `DELETE`: delete an OAuthAuthorizeToken - `GET`: read the specified OAuthAuthorizeToken - `PATCH`: partially update the specified OAuthAuthorizeToken - `PUT`: replace the specified OAuthAuthorizeToken +* `/apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name}` +- `GET`: watch changes to an object of kind OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/oauth.openshift.io/v1/oauthauthorizetokens @@ -160,7 +166,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -169,7 +175,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -226,7 +234,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#oauthauthorizetokenlist-oauth-openshift-io-v1[`OAuthAuthorizeTokenList oauth.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.oauth.v1.OAuthAuthorizeTokenList[`OAuthAuthorizeTokenList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -253,7 +263,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema | |=== @@ -262,7 +272,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 201 - Created +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 202 - Accepted +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -316,7 +397,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -325,7 +406,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -340,7 +425,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -370,7 +457,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -379,7 +466,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -406,7 +495,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema | |=== @@ -415,7 +504,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 201 - Created +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`OAuthAuthorizeToken`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthauthorizetokens/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the OAuthAuthorizeToken +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind OAuthAuthorizeToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/oauth_apis/oauthclient-oauth-openshift-io-v1.adoc b/rest_api/oauth_apis/oauthclient-oauth-openshift-io-v1.adoc index 767b6bb2c9e0..05112b5be5cd 100644 --- a/rest_api/oauth_apis/oauthclient-oauth-openshift-io-v1.adoc +++ b/rest_api/oauth_apis/oauthclient-oauth-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauthclient-oauth-openshift-io-v1"] = OAuthClient [oauth.openshift.io/v1] ifdef::product-title[] @@ -51,7 +53,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `redirectURIs` @@ -75,7 +77,7 @@ Type:: | Secret is the unique secret associated with a client |=== -..scopeRestrictions +=== .scopeRestrictions Description:: + -- @@ -88,7 +90,7 @@ Type:: -..scopeRestrictions[] +=== .scopeRestrictions[] Description:: + -- @@ -114,7 +116,7 @@ Type:: | ExactValues means the scope has to match a particular set of strings exactly |=== -..scopeRestrictions[].clusterRole +=== .scopeRestrictions[].clusterRole Description:: + -- @@ -157,11 +159,15 @@ The following API endpoints are available: - `DELETE`: delete collection of OAuthClient - `GET`: list or watch objects of kind OAuthClient - `POST`: create an OAuthClient +* `/apis/oauth.openshift.io/v1/watch/oauthclients` +- `GET`: watch individual changes to a list of OAuthClient. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/oauth.openshift.io/v1/oauthclients/{name}` - `DELETE`: delete an OAuthClient - `GET`: read the specified OAuthClient - `PATCH`: partially update the specified OAuthClient - `PUT`: replace the specified OAuthClient +* `/apis/oauth.openshift.io/v1/watch/oauthclients/{name}` +- `GET`: watch changes to an object of kind OAuthClient. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/oauth.openshift.io/v1/oauthclients @@ -235,7 +241,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -244,7 +250,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -301,7 +309,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#oauthclientlist-oauth-openshift-io-v1[`OAuthClientList oauth.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.oauth.v1.OAuthClientList[`OAuthClientList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -328,7 +338,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema | |=== @@ -337,7 +347,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 201 - Created +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 202 - Accepted +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthclients + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of OAuthClient. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -391,7 +472,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -400,7 +481,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -415,7 +500,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -445,7 +532,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -454,7 +541,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -481,7 +570,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema | |=== @@ -490,7 +579,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 201 - Created +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`OAuthClient`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthclients/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the OAuthClient +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind OAuthClient. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc b/rest_api/oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc index b3c5a85f7409..42a31ecd8393 100644 --- a/rest_api/oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc +++ b/rest_api/oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="oauthclientauthorization-oauth-openshift-io-v1"] = OAuthClientAuthorization [oauth.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `scopes` @@ -62,11 +64,15 @@ The following API endpoints are available: - `DELETE`: delete collection of OAuthClientAuthorization - `GET`: list or watch objects of kind OAuthClientAuthorization - `POST`: create an OAuthClientAuthorization +* `/apis/oauth.openshift.io/v1/watch/oauthclientauthorizations` +- `GET`: watch individual changes to a list of OAuthClientAuthorization. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/oauth.openshift.io/v1/oauthclientauthorizations/{name}` - `DELETE`: delete an OAuthClientAuthorization - `GET`: read the specified OAuthClientAuthorization - `PATCH`: partially update the specified OAuthClientAuthorization - `PUT`: replace the specified OAuthClientAuthorization +* `/apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name}` +- `GET`: watch changes to an object of kind OAuthClientAuthorization. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/oauth.openshift.io/v1/oauthclientauthorizations @@ -140,7 +146,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -149,7 +155,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -206,7 +214,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#oauthclientauthorizationlist-oauth-openshift-io-v1[`OAuthClientAuthorizationList oauth.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.oauth.v1.OAuthClientAuthorizationList[`OAuthClientAuthorizationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -233,7 +243,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema | |=== @@ -242,7 +252,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 201 - Created +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 202 - Accepted +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of OAuthClientAuthorization. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -296,7 +377,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -305,7 +386,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -320,7 +405,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -350,7 +437,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -359,7 +446,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -386,7 +475,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema | |=== @@ -395,7 +484,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization oauth.openshift.io/v1`] +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 201 - Created +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`OAuthClientAuthorization`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/oauthclientauthorizations/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the OAuthClientAuthorization +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind OAuthClientAuthorization. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc b/rest_api/oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc index 5fb890825452..b1b28de8d2bb 100644 --- a/rest_api/oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc +++ b/rest_api/oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="useroauthaccesstoken-oauth-openshift-io-v1"] = UserOAuthAccessToken [oauth.openshift.io/v1] ifdef::product-title[] @@ -49,7 +51,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `redirectURI` @@ -80,9 +82,13 @@ The following API endpoints are available: * `/apis/oauth.openshift.io/v1/useroauthaccesstokens` - `GET`: list or watch objects of kind UserOAuthAccessToken +* `/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens` +- `GET`: watch individual changes to a list of UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/oauth.openshift.io/v1/useroauthaccesstokens/{name}` - `DELETE`: delete an UserOAuthAccessToken - `GET`: read the specified UserOAuthAccessToken +* `/apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name}` +- `GET`: watch changes to an object of kind UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/oauth.openshift.io/v1/useroauthaccesstokens @@ -144,7 +150,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#useroauthaccesstokenlist-oauth-openshift-io-v1[`UserOAuthAccessTokenList oauth.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.oauth.v1.UserOAuthAccessTokenList[`UserOAuthAccessTokenList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -198,7 +271,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -207,7 +280,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -222,7 +299,82 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`UserOAuthAccessToken oauth.openshift.io/v1`] +| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`UserOAuthAccessToken`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/oauth.openshift.io/v1/watch/useroauthaccesstokens/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the UserOAuthAccessToken +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind UserOAuthAccessToken. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/objects/index.adoc b/rest_api/objects/index.adoc index 30df544a8dd8..975edb981369 100644 --- a/rest_api/objects/index.adoc +++ b/rest_api/objects/index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="api-object-reference"] = Common object reference ifdef::product-title[] @@ -6,76 +8,96 @@ endif::[] toc::[] -[id="affinity-core-v1"] -== Affinity [core/v1] +[id="com.coreos.monitoring.v1.AlertmanagerList"] +== com.coreos.monitoring.v1.AlertmanagerList schema Description:: + -- -Affinity is a group of affinity scheduling rules. +AlertmanagerList is a list of Alertmanager -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `nodeAffinity` -| xref:../objects/index.adoc#nodeaffinity-core-v1[`NodeAffinity core/v1`] -| Describes node affinity scheduling rules for the pod. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`array (Alertmanager)`] +| List of alertmanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `podAffinity` -| xref:../objects/index.adoc#podaffinity-core-v1[`PodAffinity core/v1`] -| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `podAntiAffinity` -| xref:../objects/index.adoc#podantiaffinity-core-v1[`PodAntiAffinity core/v1`] -| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="aggregationrule-rbac-authorization-k8s-io-v1"] -== AggregationRule [rbac.authorization.k8s.io/v1] +[id="com.coreos.monitoring.v1.PodMonitorList"] +== com.coreos.monitoring.v1.PodMonitorList schema Description:: + -- -AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole +PodMonitorList is a list of PodMonitor -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `clusterRoleSelectors` -| xref:../objects/index.adoc#labelselector-meta-v1[`array (LabelSelector meta/v1)`] -| ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`array (PodMonitor)`] +| List of podmonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="alertmanagerconfiglist-monitoring-coreos-com-v1alpha1"] -== AlertmanagerConfigList [monitoring.coreos.com/v1alpha1] +[id="com.coreos.monitoring.v1.ProbeList"] +== com.coreos.monitoring.v1.ProbeList schema Description:: + -- -AlertmanagerConfigList is a list of AlertmanagerConfig +ProbeList is a list of Probe -- Type:: @@ -85,7 +107,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -96,27 +118,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`array (AlertmanagerConfig monitoring.coreos.com/v1alpha1)`] -| List of alertmanagerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`array (Probe)`] +| List of probes. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="alertmanagerlist-monitoring-coreos-com-v1"] -== AlertmanagerList [monitoring.coreos.com/v1] +[id="com.coreos.monitoring.v1.PrometheusList"] +== com.coreos.monitoring.v1.PrometheusList schema Description:: + -- -AlertmanagerList is a list of Alertmanager +PrometheusList is a list of Prometheus -- Type:: @@ -126,7 +148,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -137,27 +159,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc#alertmanager-monitoring-coreos-com-v1[`array (Alertmanager monitoring.coreos.com/v1)`] -| List of alertmanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`array (Prometheus)`] +| List of prometheuses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="apirequestcountlist-apiserver-openshift-io-v1"] -== APIRequestCountList [apiserver.openshift.io/v1] +[id="com.coreos.monitoring.v1.PrometheusRuleList"] +== com.coreos.monitoring.v1.PrometheusRuleList schema Description:: + -- -APIRequestCountList is a list of APIRequestCount +PrometheusRuleList is a list of PrometheusRule -- Type:: @@ -167,7 +189,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -178,27 +200,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`array (APIRequestCount apiserver.openshift.io/v1)`] -| List of apirequestcounts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`array (PrometheusRule)`] +| List of prometheusrules. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="apiserverlist-config-openshift-io-v1"] -== APIServerList [config.openshift.io/v1] +[id="com.coreos.monitoring.v1.ServiceMonitorList"] +== com.coreos.monitoring.v1.ServiceMonitorList schema Description:: + -- -APIServerList is a list of APIServer +ServiceMonitorList is a list of ServiceMonitor -- Type:: @@ -208,7 +230,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -219,27 +241,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`array (APIServer config.openshift.io/v1)`] -| List of apiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`array (ServiceMonitor)`] +| List of servicemonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="apiservicelist-apiregistration-k8s-io-v1"] -== APIServiceList [apiregistration.k8s.io/v1] +[id="com.coreos.monitoring.v1.ThanosRulerList"] +== com.coreos.monitoring.v1.ThanosRulerList schema Description:: + -- -APIServiceList is a list of APIService objects. +ThanosRulerList is a list of ThanosRuler -- Type:: @@ -249,7 +271,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -260,27 +282,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`array (APIService apiregistration.k8s.io/v1)`] -| Items is the list of APIService +| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`array (ThanosRuler)`] +| List of thanosrulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="appliedclusterresourcequotalist-quota-openshift-io-v1"] -== AppliedClusterResourceQuotaList [quota.openshift.io/v1] +[id="com.coreos.monitoring.v1alpha1.AlertmanagerConfigList"] +== com.coreos.monitoring.v1alpha1.AlertmanagerConfigList schema Description:: + -- -AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas +AlertmanagerConfigList is a list of AlertmanagerConfig -- Type:: @@ -290,7 +312,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -301,61 +323,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc#appliedclusterresourcequota-quota-openshift-io-v1[`array (AppliedClusterResourceQuota quota.openshift.io/v1)`] -| Items is a list of AppliedClusterResourceQuota +| xref:../monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc#alertmanagerconfig-monitoring-coreos-com-v1alpha1[`array (AlertmanagerConfig)`] +| List of alertmanagerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="attachedvolume-core-v1"] -== AttachedVolume [core/v1] +[id="com.coreos.operators.v1.OperatorGroupList"] +== com.coreos.operators.v1.OperatorGroupList schema Description:: + -- -AttachedVolume describes a volume attached to a node +OperatorGroupList is a list of OperatorGroup -- Type:: `object` Required:: - - `name` - - `devicePath` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `devicePath` +| `apiVersion` | `string` -| DevicePath represents the device path where the volume should be available +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `name` +| `items` +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`array (OperatorGroup)`] +| List of operatorgroups. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Name of the attached volume +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="authenticationlist-config-openshift-io-v1"] -== AuthenticationList [config.openshift.io/v1] +[id="com.coreos.operators.v1.OperatorList"] +== com.coreos.operators.v1.OperatorList schema Description:: + -- -AuthenticationList is a list of Authentication +OperatorList is a list of Operator -- Type:: @@ -365,7 +394,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -376,27 +405,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`array (Authentication config.openshift.io/v1)`] -| List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`array (Operator)`] +| List of operators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="authenticationlist-operator-openshift-io-v1"] -== AuthenticationList [operator.openshift.io/v1] +[id="com.coreos.operators.v1alpha1.CatalogSourceList"] +== com.coreos.operators.v1alpha1.CatalogSourceList schema Description:: + -- -AuthenticationList is a list of Authentication +CatalogSourceList is a list of CatalogSource -- Type:: @@ -406,7 +435,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -417,200 +446,191 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`array (Authentication operator.openshift.io/v1)`] -| List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`array (CatalogSource)`] +| List of catalogsources. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="awselasticblockstorevolumesource-core-v1"] -== AWSElasticBlockStoreVolumeSource [core/v1] +[id="com.coreos.operators.v1alpha1.ClusterServiceVersionList"] +== com.coreos.operators.v1alpha1.ClusterServiceVersionList schema Description:: + -- -Represents a Persistent Disk resource in AWS. - -An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. +ClusterServiceVersionList is a list of ClusterServiceVersion -- Type:: `object` Required:: - - `volumeID` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - -| `partition` -| `integer` -| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `readOnly` -| `boolean` -| Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +| `items` +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`array (ClusterServiceVersion)`] +| List of clusterserviceversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `volumeID` +| `kind` | `string` -| Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="azurediskvolumesource-core-v1"] -== AzureDiskVolumeSource [core/v1] +[id="com.coreos.operators.v1alpha1.InstallPlanList"] +== com.coreos.operators.v1alpha1.InstallPlanList schema Description:: + -- -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +InstallPlanList is a list of InstallPlan -- Type:: `object` Required:: - - `diskName` - - `diskURI` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `cachingMode` -| `string` -| Host Caching mode: None, Read Only, Read Write. - -| `diskName` -| `string` -| The Name of the data disk in the blob storage - -| `diskURI` +| `apiVersion` | `string` -| The URI the data disk in the blob storage +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `fsType` -| `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +| `items` +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`array (InstallPlan)`] +| List of installplans. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` -| Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="azurefilepersistentvolumesource-core-v1"] -== AzureFilePersistentVolumeSource [core/v1] +[id="com.coreos.operators.v1alpha1.SubscriptionList"] +== com.coreos.operators.v1alpha1.SubscriptionList schema Description:: + -- -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +SubscriptionList is a list of Subscription -- Type:: `object` Required:: - - `secretName` - - `shareName` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - -| `secretName` +| `apiVersion` | `string` -| the name of secret that contains Azure Storage Account Name and Key +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretNamespace` -| `string` -| the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod +| `items` +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`array (Subscription)`] +| List of subscriptions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `shareName` +| `kind` | `string` -| Share Name +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="azurefilevolumesource-core-v1"] -== AzureFileVolumeSource [core/v1] +[id="com.coreos.operators.v2.OperatorConditionList"] +== com.coreos.operators.v2.OperatorConditionList schema Description:: + -- -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +OperatorConditionList is a list of OperatorCondition -- Type:: `object` Required:: - - `secretName` - - `shareName` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - -| `secretName` +| `apiVersion` | `string` -| the name of secret that contains Azure Storage Account Name and Key +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `shareName` +| `items` +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`array (OperatorCondition)`] +| List of operatorconditions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Share Name +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="baremetalhostlist-metal3-io-v1alpha1"] -== BareMetalHostList [metal3.io/v1alpha1] +[id="com.github.openshift.api.apps.v1.DeploymentConfigList"] +== com.github.openshift.api.apps.v1.DeploymentConfigList schema Description:: + -- -BareMetalHostList is a list of BareMetalHost +DeploymentConfigList is a collection of deployment configs. -- Type:: @@ -620,7 +640,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -631,27 +651,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`array (BareMetalHost metal3.io/v1alpha1)`] -| List of baremetalhosts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`array (DeploymentConfig)`] +| Items is a list of deployment configs | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="brokertemplateinstancelist-template-openshift-io-v1"] -== BrokerTemplateInstanceList [template.openshift.io/v1] +[id="com.github.openshift.api.authorization.v1.ClusterRoleBindingList"] +== com.github.openshift.api.authorization.v1.ClusterRoleBindingList schema Description:: + -- -BrokerTemplateInstanceList is a list of BrokerTemplateInstance objects. +ClusterRoleBindingList is a collection of ClusterRoleBindings -- Type:: @@ -661,7 +681,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -672,27 +692,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`array (BrokerTemplateInstance template.openshift.io/v1)`] -| items is a list of BrokerTemplateInstances +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`array (ClusterRoleBinding)`] +| Items is a list of ClusterRoleBindings | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="buildconfiglist-build-openshift-io-v1"] -== BuildConfigList [build.openshift.io/v1] +[id="com.github.openshift.api.authorization.v1.ClusterRoleList"] +== com.github.openshift.api.authorization.v1.ClusterRoleList schema Description:: + -- -BuildConfigList is a collection of BuildConfigs. +ClusterRoleList is a collection of ClusterRoles -- Type:: @@ -702,7 +722,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -713,27 +733,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`array (BuildConfig build.openshift.io/v1)`] -| items is a list of build configs +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`array (ClusterRole)`] +| Items is a list of ClusterRoles | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="buildlist-build-openshift-io-v1"] -== BuildList [build.openshift.io/v1] +[id="com.github.openshift.api.authorization.v1.RoleBindingList"] +== com.github.openshift.api.authorization.v1.RoleBindingList schema Description:: + -- -BuildList is a collection of Builds. +RoleBindingList is a collection of RoleBindings -- Type:: @@ -743,7 +763,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -754,27 +774,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`array (Build build.openshift.io/v1)`] -| items is a list of builds +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`array (RoleBinding)`] +| Items is a list of RoleBindings | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="buildlist-config-openshift-io-v1"] -== BuildList [config.openshift.io/v1] +[id="com.github.openshift.api.authorization.v1.RoleList"] +== com.github.openshift.api.authorization.v1.RoleList schema Description:: + -- -BuildList is a list of Build +RoleList is a collection of Roles -- Type:: @@ -784,7 +804,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -795,35 +815,37 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`array (Build config.openshift.io/v1)`] -| List of builds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`array (Role)`] +| Items is a list of Roles | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="buildlog-build-openshift-io-v1"] -== BuildLog [build.openshift.io/v1] +[id="com.github.openshift.api.build.v1.BuildConfigList"] +== com.github.openshift.api.build.v1.BuildConfigList schema Description:: + -- -BuildLog is the (unused) resource associated with the build log redirector +BuildConfigList is a collection of BuildConfigs. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -833,28 +855,38 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`array (BuildConfig)`] +| items is a list of build configs + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| + |=== -[id="buildrequest-build-openshift-io-v1"] -== BuildRequest [build.openshift.io/v1] +[id="com.github.openshift.api.build.v1.BuildList"] +== com.github.openshift.api.build.v1.BuildList schema Description:: + -- -BuildRequest is the resource used to pass parameters to build generator +BuildList is a collection of Builds. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -864,91 +896,69 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `binary` -| xref:../objects/index.adoc#binarybuildsource-build-openshift-io-v1[`BinaryBuildSource build.openshift.io/v1`] -| binary indicates a request to build from a binary provided to the builder - -| `dockerStrategyOptions` -| xref:../objects/index.adoc#dockerstrategyoptions-build-openshift-io-v1[`DockerStrategyOptions build.openshift.io/v1`] -| DockerStrategyOptions contains additional docker-strategy specific options for the build - -| `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] -| env contains additional environment variables you want to pass into a builder container. - -| `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] -| from is the reference to the ImageStreamTag that triggered the build. +| `items` +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`array (Build)`] +| items is a list of builds | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `lastVersion` -| `integer` -| lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn't match, a build will not be generated. - | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | -| `revision` -| xref:../objects/index.adoc#sourcerevision-build-openshift-io-v1[`SourceRevision build.openshift.io/v1`] -| revision is the information from the source for a specific repo snapshot. - -| `sourceStrategyOptions` -| xref:../objects/index.adoc#sourcestrategyoptions-build-openshift-io-v1[`SourceStrategyOptions build.openshift.io/v1`] -| SourceStrategyOptions contains additional source-strategy specific options for the build - -| `triggeredBy` -| xref:../objects/index.adoc#buildtriggercause-build-openshift-io-v1[`array (BuildTriggerCause build.openshift.io/v1)`] -| triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers. - -| `triggeredByImage` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] -| triggeredByImage is the Image that triggered this build. - |=== -[id="capabilities-core-v1"] -== Capabilities [core/v1] +[id="com.github.openshift.api.image.v1.ImageList"] +== com.github.openshift.api.image.v1.ImageList schema Description:: + -- -Adds and removes POSIX capabilities from running containers. +ImageList is a list of Image objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `add` -| `array (string)` -| Added capabilities +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `drop` -| `array (string)` -| Removed capabilities +| `items` +| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`array (Image)`] +| Items is a list of images + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="catalogsourcelist-operators-coreos-com-v1alpha1"] -== CatalogSourceList [operators.coreos.com/v1alpha1] +[id="com.github.openshift.api.image.v1.ImageStreamList"] +== com.github.openshift.api.image.v1.ImageStreamList schema Description:: + -- -CatalogSourceList is a list of CatalogSource +ImageStreamList is a list of ImageStream objects. -- Type:: @@ -958,7 +968,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -969,125 +979,109 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`array (CatalogSource operators.coreos.com/v1alpha1)`] -| List of catalogsources. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`array (ImageStream)`] +| Items is a list of imageStreams | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="cephfspersistentvolumesource-core-v1"] -== CephFSPersistentVolumeSource [core/v1] +[id="com.github.openshift.api.image.v1.ImageStreamTagList"] +== com.github.openshift.api.image.v1.ImageStreamTagList schema Description:: + -- -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +ImageStreamTagList is a list of ImageStreamTag objects. -- Type:: `object` Required:: - - `monitors` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `monitors` -| `array (string)` -| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - -| `path` +| `apiVersion` | `string` -| Optional: Used as the mounted root, rather than the full Ceph tree, default is / +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| `items` +| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`array (ImageStreamTag)`] +| Items is the list of image stream tags -| `secretFile` +| `kind` | `string` -| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `user` -| `string` -| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="cephfsvolumesource-core-v1"] -== CephFSVolumeSource [core/v1] +[id="com.github.openshift.api.image.v1.ImageTagList"] +== com.github.openshift.api.image.v1.ImageTagList schema Description:: + -- -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +ImageTagList is a list of ImageTag objects. When listing image tags, the image field is not populated. Tags are returned in alphabetical order by image stream and then tag. -- Type:: `object` Required:: - - `monitors` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `monitors` -| `array (string)` -| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - -| `path` +| `apiVersion` | `string` -| Optional: Used as the mounted root, rather than the full Ceph tree, default is / +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| `items` +| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`array (ImageTag)`] +| Items is the list of image stream tags -| `secretFile` +| `kind` | `string` -| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it - -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `user` -| `string` -| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="certificatesigningrequestlist-certificates-k8s-io-v1"] -== CertificateSigningRequestList [certificates.k8s.io/v1] +[id="com.github.openshift.api.oauth.v1.OAuthAccessTokenList"] +== com.github.openshift.api.oauth.v1.OAuthAccessTokenList schema Description:: + -- -CertificateSigningRequestList is a collection of CertificateSigningRequest objects +OAuthAccessTokenList is a collection of OAuth access tokens -- Type:: @@ -1097,7 +1091,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1108,136 +1102,150 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`array (CertificateSigningRequest certificates.k8s.io/v1)`] -| items is a collection of CertificateSigningRequest objects +| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`array (OAuthAccessToken)`] +| Items is the list of OAuth access tokens | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="cinderpersistentvolumesource-core-v1"] -== CinderPersistentVolumeSource [core/v1] +[id="com.github.openshift.api.oauth.v1.OAuthAuthorizeTokenList"] +== com.github.openshift.api.oauth.v1.OAuthAuthorizeTokenList schema Description:: + -- -Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +OAuthAuthorizeTokenList is a collection of OAuth authorization tokens -- Type:: `object` Required:: - - `volumeID` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| Optional: points to a secret object containing parameters used to connect to OpenStack. +| `items` +| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`array (OAuthAuthorizeToken)`] +| Items is the list of OAuth authorization tokens -| `volumeID` +| `kind` | `string` -| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="cindervolumesource-core-v1"] -== CinderVolumeSource [core/v1] +[id="com.github.openshift.api.oauth.v1.OAuthClientAuthorizationList"] +== com.github.openshift.api.oauth.v1.OAuthClientAuthorizationList schema Description:: + -- -Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +OAuthClientAuthorizationList is a collection of OAuth client authorizations -- Type:: `object` Required:: - - `volumeID` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| Optional: points to a secret object containing parameters used to connect to OpenStack. +| `items` +| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`array (OAuthClientAuthorization)`] +| Items is the list of OAuth client authorizations -| `volumeID` +| `kind` | `string` -| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clientipconfig-core-v1"] -== ClientIPConfig [core/v1] +[id="com.github.openshift.api.oauth.v1.OAuthClientList"] +== com.github.openshift.api.oauth.v1.OAuthClientList schema Description:: + -- -ClientIPConfig represents the configurations of Client IP based session affinity. +OAuthClientList is a collection of OAuth clients -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `timeoutSeconds` -| `integer` -| timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`array (OAuthClient)`] +| Items is the list of OAuth clients + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="cloudcredentiallist-operator-openshift-io-v1"] -== CloudCredentialList [operator.openshift.io/v1] +[id="com.github.openshift.api.oauth.v1.UserOAuthAccessTokenList"] +== com.github.openshift.api.oauth.v1.UserOAuthAccessTokenList schema Description:: + -- -CloudCredentialList is a list of CloudCredential +UserOAuthAccessTokenList is a collection of access tokens issued on behalf of the requesting user -- Type:: @@ -1247,7 +1255,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1258,27 +1266,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`array (CloudCredential operator.openshift.io/v1)`] -| List of cloudcredentials. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`array (UserOAuthAccessToken)`] +| | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterautoscalerlist-autoscaling-openshift-io-v1"] -== ClusterAutoscalerList [autoscaling.openshift.io/v1] +[id="com.github.openshift.api.project.v1.ProjectList"] +== com.github.openshift.api.project.v1.ProjectList schema Description:: + -- -ClusterAutoscalerList is a list of ClusterAutoscaler +ProjectList is a list of Project objects. -- Type:: @@ -1288,7 +1296,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1299,27 +1307,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`array (ClusterAutoscaler autoscaling.openshift.io/v1)`] -| List of clusterautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`array (Project)`] +| Items is the list of projects | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clustercsidriverlist-operator-openshift-io-v1"] -== ClusterCSIDriverList [operator.openshift.io/v1] +[id="com.github.openshift.api.quota.v1.AppliedClusterResourceQuotaList"] +== com.github.openshift.api.quota.v1.AppliedClusterResourceQuotaList schema Description:: + -- -ClusterCSIDriverList is a list of ClusterCSIDriver +AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas -- Type:: @@ -1329,7 +1337,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1340,27 +1348,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`array (ClusterCSIDriver operator.openshift.io/v1)`] -| List of clustercsidrivers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc#appliedclusterresourcequota-quota-openshift-io-v1[`array (AppliedClusterResourceQuota)`] +| Items is a list of AppliedClusterResourceQuota | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusternetworklist-network-openshift-io-v1"] -== ClusterNetworkList [network.openshift.io/v1] +[id="com.github.openshift.api.route.v1.RouteList"] +== com.github.openshift.api.route.v1.RouteList schema Description:: + -- -ClusterNetworkList is a list of ClusterNetwork +RouteList is a collection of Routes. -- Type:: @@ -1370,7 +1378,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1381,27 +1389,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`array (ClusterNetwork network.openshift.io/v1)`] -| List of clusternetworks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`array (Route)`] +| items is a list of routes | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusteroperatorlist-config-openshift-io-v1"] -== ClusterOperatorList [config.openshift.io/v1] +[id="com.github.openshift.api.security.v1.RangeAllocationList"] +== com.github.openshift.api.security.v1.RangeAllocationList schema Description:: + -- -ClusterOperatorList is a list of ClusterOperator +RangeAllocationList is a list of RangeAllocations objects -- Type:: @@ -1411,7 +1419,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1422,27 +1430,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`array (ClusterOperator config.openshift.io/v1)`] -| List of clusteroperators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`array (RangeAllocation)`] +| List of RangeAllocations. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterresourcequotalist-quota-openshift-io-v1"] -== ClusterResourceQuotaList [quota.openshift.io/v1] +[id="com.github.openshift.api.template.v1.BrokerTemplateInstanceList"] +== com.github.openshift.api.template.v1.BrokerTemplateInstanceList schema Description:: + -- -ClusterResourceQuotaList is a list of ClusterResourceQuota +BrokerTemplateInstanceList is a list of BrokerTemplateInstance objects. -- Type:: @@ -1452,7 +1460,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1463,27 +1471,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`array (ClusterResourceQuota quota.openshift.io/v1)`] -| List of clusterresourcequotas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`array (BrokerTemplateInstance)`] +| items is a list of BrokerTemplateInstances | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterrolebindinglist-authorization-openshift-io-v1"] -== ClusterRoleBindingList [authorization.openshift.io/v1] +[id="com.github.openshift.api.template.v1.TemplateInstanceList"] +== com.github.openshift.api.template.v1.TemplateInstanceList schema Description:: + -- -ClusterRoleBindingList is a collection of ClusterRoleBindings +TemplateInstanceList is a list of TemplateInstance objects. -- Type:: @@ -1493,7 +1501,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1504,27 +1512,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`array (ClusterRoleBinding authorization.openshift.io/v1)`] -| Items is a list of ClusterRoleBindings +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`array (TemplateInstance)`] +| items is a list of Templateinstances | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="clusterrolebindinglist-rbac-authorization-k8s-io-v1"] -== ClusterRoleBindingList [rbac.authorization.k8s.io/v1] +[id="com.github.openshift.api.template.v1.TemplateList"] +== com.github.openshift.api.template.v1.TemplateList schema Description:: + -- -ClusterRoleBindingList is a collection of ClusterRoleBindings +TemplateList is a list of Template objects. -- Type:: @@ -1534,7 +1542,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1545,27 +1553,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`array (ClusterRoleBinding rbac.authorization.k8s.io/v1)`] -| Items is a list of ClusterRoleBindings +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`array (Template)`] +| Items is a list of templates | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterrolelist-authorization-openshift-io-v1"] -== ClusterRoleList [authorization.openshift.io/v1] +[id="com.github.openshift.api.user.v1.GroupList"] +== com.github.openshift.api.user.v1.GroupList schema Description:: + -- -ClusterRoleList is a collection of ClusterRoles +GroupList is a collection of Groups -- Type:: @@ -1575,7 +1583,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1586,27 +1594,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`array (ClusterRole authorization.openshift.io/v1)`] -| Items is a list of ClusterRoles +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`array (Group)`] +| Items is the list of groups | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | |=== -[id="clusterrolelist-rbac-authorization-k8s-io-v1"] -== ClusterRoleList [rbac.authorization.k8s.io/v1] +[id="com.github.openshift.api.user.v1.IdentityList"] +== com.github.openshift.api.user.v1.IdentityList schema Description:: + -- -ClusterRoleList is a collection of ClusterRoles +IdentityList is a collection of Identities -- Type:: @@ -1616,7 +1624,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1627,27 +1635,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`array (ClusterRole rbac.authorization.k8s.io/v1)`] -| Items is a list of ClusterRoles +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`array (Identity)`] +| Items is the list of identities | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterserviceversionlist-operators-coreos-com-v1alpha1"] -== ClusterServiceVersionList [operators.coreos.com/v1alpha1] +[id="com.github.openshift.api.user.v1.UserList"] +== com.github.openshift.api.user.v1.UserList schema Description:: + -- -ClusterServiceVersionList is a list of ClusterServiceVersion +UserList is a collection of Users -- Type:: @@ -1657,7 +1665,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1668,68 +1676,106 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`array (ClusterServiceVersion operators.coreos.com/v1alpha1)`] -| List of clusterserviceversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`array (User)`] +| Items is the list of users | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="clusterversionlist-config-openshift-io-v1"] -== ClusterVersionList [config.openshift.io/v1] +[id="com.github.operator-framework.api.pkg.lib.version.OperatorVersion"] +== com.github.operator-framework.api.pkg.lib.version.OperatorVersion schema Description:: + -- -ClusterVersionList is a list of ClusterVersion +OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON. +-- + +Type:: + `string` + + + +[id="com.github.operator-framework.api.pkg.operators.v1alpha1.APIServiceDefinitions"] +== com.github.operator-framework.api.pkg.operators.v1alpha1.APIServiceDefinitions schema + + +Description:: ++ +-- +APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `owned` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.APIServiceDescription[`array (APIServiceDescription)`] +| -| `items` -| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`array (ClusterVersion config.openshift.io/v1)`] -| List of clusterversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `required` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.APIServiceDescription[`array (APIServiceDescription)`] +| -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +|=== -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +[id="com.github.operator-framework.api.pkg.operators.v1alpha1.CustomResourceDefinitions"] +== com.github.operator-framework.api.pkg.operators.v1alpha1.CustomResourceDefinitions schema + + +Description:: ++ +-- +CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. + +If the CRD is present in the Owned list, it is implicitly required. +-- + +Type:: + `object` + + +[discrete] +=== Schema + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `owned` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.CRDDescription[`array (CRDDescription)`] +| + +| `required` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.CRDDescription[`array (CRDDescription)`] +| |=== -[id="componentcondition-core-v1"] -== ComponentCondition [core/v1] +[id="com.github.operator-framework.api.pkg.operators.v1alpha1.InstallMode"] +== com.github.operator-framework.api.pkg.operators.v1alpha1.InstallMode schema Description:: + -- -Information about the condition of a component. +InstallMode associates an InstallModeType with a flag representing if the CSV supports it -- Type:: @@ -1737,41 +1783,33 @@ Type:: Required:: - `type` - - `status` + - `supported` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `error` -| `string` -| Condition error code for a component. For example, a health check error code. - -| `message` -| `string` -| Message about the condition for a component. For example, information about a health check. - -| `status` -| `string` -| Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". +| `supported` +| `boolean` +| | `type` | `string` -| Type of condition for a component. Valid value: "Healthy" +| |=== -[id="componentstatuslist-core-v1"] -== ComponentStatusList [core/v1] +[id="com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifestList"] +== com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifestList schema Description:: + -- -Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ +PackageManifestList is a list of PackageManifest objects. -- Type:: @@ -1781,7 +1819,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1792,80 +1830,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../metadata_apis/componentstatus-core-v1.adoc#componentstatus-core-v1[`array (ComponentStatus core/v1)`] -| List of ComponentStatus objects. +| xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`array (PackageManifest)`] +| | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="condition-meta-v1"] -== Condition [meta/v1] +[id="io.cncf.cni.k8s.v1.NetworkAttachmentDefinitionList"] +== io.cncf.cni.k8s.v1.NetworkAttachmentDefinitionList schema Description:: + -- -Condition contains details for one aspect of the current state of this API Resource. +NetworkAttachmentDefinitionList is a list of NetworkAttachmentDefinition -- Type:: `object` Required:: - - `type` - - `status` - - `lastTransitionTime` - - `reason` - - `message` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - -| `message` +| `apiVersion` | `string` -| message is a human readable message indicating details about the transition. This may be an empty string. - -| `observedGeneration` -| `integer` -| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `reason` -| `string` -| reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. +| `items` +| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`array (NetworkAttachmentDefinition)`] +| List of network-attachment-definitions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `status` +| `kind` | `string` -| status of the condition, one of True, False, Unknown. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `type` -| `string` -| type of condition in CamelCase or in foo.example.com/CamelCase. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="configlist-imageregistry-operator-openshift-io-v1"] -== ConfigList [imageregistry.operator.openshift.io/v1] +[id="io.cncf.cni.whereabouts.v1alpha1.IPPoolList"] +== io.cncf.cni.whereabouts.v1alpha1.IPPoolList schema Description:: + -- -ConfigList is a list of Config +IPPoolList is a list of IPPool -- Type:: @@ -1875,7 +1901,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1886,27 +1912,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`array (Config imageregistry.operator.openshift.io/v1)`] -| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`array (IPPool)`] +| List of ippools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="configlist-operator-openshift-io-v1"] -== ConfigList [operator.openshift.io/v1] +[id="io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList"] +== io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList schema Description:: + -- -ConfigList is a list of Config +MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. -- Type:: @@ -1916,7 +1942,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1927,27 +1953,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`array (Config operator.openshift.io/v1)`] -| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`array (MutatingWebhookConfiguration)`] +| List of MutatingWebhookConfiguration. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="configlist-samples-operator-openshift-io-v1"] -== ConfigList [samples.operator.openshift.io/v1] +[id="io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList"] +== io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList schema Description:: + -- -ConfigList is a list of Config +ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. -- Type:: @@ -1957,7 +1983,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -1968,97 +1994,109 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`array (Config samples.operator.openshift.io/v1)`] -| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`array (ValidatingWebhookConfiguration)`] +| List of ValidatingWebhookConfiguration. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="configmapenvsource-core-v1"] -== ConfigMapEnvSource [core/v1] +[id="io.k8s.api.apps.v1.ControllerRevisionList"] +== io.k8s.api.apps.v1.ControllerRevisionList schema Description:: + -- -ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. - -The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +ControllerRevisionList is a resource containing a list of ControllerRevision objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `optional` -| `boolean` -| Specify whether the ConfigMap must be defined +| `items` +| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`array (ControllerRevision)`] +| Items is the list of ControllerRevisions + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="configmapkeyselector-core-v1"] -== ConfigMapKeySelector [core/v1] +[id="io.k8s.api.apps.v1.DaemonSetList"] +== io.k8s.api.apps.v1.DaemonSetList schema Description:: + -- -Selects a key from a ConfigMap. +DaemonSetList is a collection of daemon sets. -- Type:: `object` Required:: - - `key` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `key` +| `apiVersion` | `string` -| The key to select. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `name` +| `items` +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`array (DaemonSet)`] +| A list of daemon sets. + +| `kind` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `optional` -| `boolean` -| Specify whether the ConfigMap or its key must be defined +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="configmaplist-core-v1"] -== ConfigMapList [core/v1] +[id="io.k8s.api.apps.v1.DeploymentList"] +== io.k8s.api.apps.v1.DeploymentList schema Description:: + -- -ConfigMapList is a resource containing a list of ConfigMap objects. +DeploymentList is a list of Deployments. -- Type:: @@ -2068,7 +2106,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2079,162 +2117,158 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../metadata_apis/configmap-core-v1.adoc#configmap-core-v1[`array (ConfigMap core/v1)`] -| Items is the list of ConfigMaps. +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`array (Deployment)`] +| Items is the list of Deployments. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. |=== -[id="configmapnodeconfigsource-core-v1"] -== ConfigMapNodeConfigSource [core/v1] +[id="io.k8s.api.apps.v1.ReplicaSetList"] +== io.k8s.api.apps.v1.ReplicaSetList schema Description:: + -- -ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration +ReplicaSetList is a collection of ReplicaSets. -- Type:: `object` Required:: - - `namespace` - - `name` - - `kubeletConfigKey` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `kubeletConfigKey` +| `apiVersion` | `string` -| KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `name` -| `string` -| Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. - -| `namespace` -| `string` -| Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. +| `items` +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`array (ReplicaSet)`] +| List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller -| `resourceVersion` +| `kind` | `string` -| ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `uid` -| `string` -| UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="configmapprojection-core-v1"] -== ConfigMapProjection [core/v1] +[id="io.k8s.api.apps.v1.StatefulSetList"] +== io.k8s.api.apps.v1.StatefulSetList schema Description:: + -- -Adapts a ConfigMap into a projected volume. - -The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. +StatefulSetList is a collection of StatefulSets. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + | `items` -| xref:../objects/index.adoc#keytopath-core-v1[`array (KeyToPath core/v1)`] -| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`array (StatefulSet)`] +| Items is the list of stateful sets. -| `name` +| `kind` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `optional` -| `boolean` -| Specify whether the ConfigMap or its keys must be defined +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="configmapvolumesource-core-v1"] -== ConfigMapVolumeSource [core/v1] +[id="io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList"] +== io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList schema Description:: + -- -Adapts a ConfigMap into a volume. - -The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. +list of horizontal pod autoscaler objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `defaultMode` -| `integer` -| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../objects/index.adoc#keytopath-core-v1[`array (KeyToPath core/v1)`] -| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`array (HorizontalPodAutoscaler)`] +| list of horizontal pod autoscaler objects. -| `name` +| `kind` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `optional` -| `boolean` -| Specify whether the ConfigMap or its keys must be defined +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. |=== -[id="consoleclidownloadlist-console-openshift-io-v1"] -== ConsoleCLIDownloadList [console.openshift.io/v1] +[id="io.k8s.api.autoscaling.v1.Scale_v2"] +== io.k8s.api.autoscaling.v1.Scale_v2 schema Description:: + -- -ConsoleCLIDownloadList is a list of ConsoleCLIDownload +Scale represents a scaling request for a resource. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2244,28 +2278,32 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`array (ConsoleCLIDownload console.openshift.io/v1)`] -| List of consoleclidownloads. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] +| Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +| `spec` +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.ScaleSpec[`ScaleSpec`] +| defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +| `status` +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.ScaleStatus[`ScaleStatus`] +| current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. |=== -[id="consoleexternalloglinklist-console-openshift-io-v1"] -== ConsoleExternalLogLinkList [console.openshift.io/v1] +[id="io.k8s.api.batch.v1.CronJobList"] +== io.k8s.api.batch.v1.CronJobList schema Description:: + -- -ConsoleExternalLogLinkList is a list of ConsoleExternalLogLink +CronJobList is a collection of cron jobs. -- Type:: @@ -2275,7 +2313,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2286,27 +2324,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`array (ConsoleExternalLogLink console.openshift.io/v1)`] -| List of consoleexternalloglinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`array (CronJob)`] +| items is the list of CronJobs. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="consolelinklist-console-openshift-io-v1"] -== ConsoleLinkList [console.openshift.io/v1] +[id="io.k8s.api.batch.v1.JobList"] +== io.k8s.api.batch.v1.JobList schema Description:: + -- -ConsoleLinkList is a list of ConsoleLink +JobList is a collection of jobs. -- Type:: @@ -2316,7 +2354,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2327,27 +2365,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`array (ConsoleLink console.openshift.io/v1)`] -| List of consolelinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`array (Job)`] +| items is the list of Jobs. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="consolelist-config-openshift-io-v1"] -== ConsoleList [config.openshift.io/v1] +[id="io.k8s.api.certificates.v1.CertificateSigningRequestList"] +== io.k8s.api.certificates.v1.CertificateSigningRequestList schema Description:: + -- -ConsoleList is a list of Console +CertificateSigningRequestList is a collection of CertificateSigningRequest objects -- Type:: @@ -2357,7 +2395,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2368,27 +2406,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`array (Console config.openshift.io/v1)`] -| List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`array (CertificateSigningRequest)`] +| items is a collection of CertificateSigningRequest objects | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| |=== -[id="consolelist-operator-openshift-io-v1"] -== ConsoleList [operator.openshift.io/v1] +[id="io.k8s.api.coordination.v1.LeaseList"] +== io.k8s.api.coordination.v1.LeaseList schema Description:: + -- -ConsoleList is a list of Console +LeaseList is a list of Lease objects. -- Type:: @@ -2398,7 +2436,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2409,27 +2447,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`array (Console operator.openshift.io/v1)`] -| List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`array (Lease)`] +| Items is a list of schema objects. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="consolenotificationlist-console-openshift-io-v1"] -== ConsoleNotificationList [console.openshift.io/v1] +[id="io.k8s.api.core.v1.ComponentStatusList"] +== io.k8s.api.core.v1.ComponentStatusList schema Description:: + -- -ConsoleNotificationList is a list of ConsoleNotification +Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ -- Type:: @@ -2439,7 +2477,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2450,27 +2488,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`array (ConsoleNotification console.openshift.io/v1)`] -| List of consolenotifications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../metadata_apis/componentstatus-v1.adoc#componentstatus-v1[`array (ComponentStatus)`] +| List of ComponentStatus objects. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="consolepluginlist-console-openshift-io-v1alpha1"] -== ConsolePluginList [console.openshift.io/v1alpha1] +[id="io.k8s.api.core.v1.ConfigMapList"] +== io.k8s.api.core.v1.ConfigMapList schema Description:: + -- -ConsolePluginList is a list of ConsolePlugin +ConfigMapList is a resource containing a list of ConfigMap objects. -- Type:: @@ -2480,7 +2518,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2491,68 +2529,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`array (ConsolePlugin console.openshift.io/v1alpha1)`] -| List of consoleplugins. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../metadata_apis/configmap-v1.adoc#configmap-v1[`array (ConfigMap)`] +| Items is the list of ConfigMaps. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="consolequickstartlist-console-openshift-io-v1"] -== ConsoleQuickStartList [console.openshift.io/v1] +[id="io.k8s.api.core.v1.ConfigMapVolumeSource"] +== io.k8s.api.core.v1.ConfigMapVolumeSource schema Description:: + -- -ConsoleQuickStartList is a list of ConsoleQuickStart +Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | `items` -| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`array (ConsoleQuickStart console.openshift.io/v1)`] -| List of consolequickstarts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../objects/index.adoc#io.k8s.api.core.v1.KeyToPath[`array (KeyToPath)`] +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. -| `kind` +| `name` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined |=== -[id="consoleyamlsamplelist-console-openshift-io-v1"] -== ConsoleYAMLSampleList [console.openshift.io/v1] +[id="io.k8s.api.core.v1.EndpointsList"] +== io.k8s.api.core.v1.EndpointsList schema Description:: + -- -ConsoleYAMLSampleList is a list of ConsoleYAMLSample +EndpointsList is a list of endpoints. -- Type:: @@ -2562,7 +2600,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2573,27 +2611,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`array (ConsoleYAMLSample console.openshift.io/v1)`] -| List of consoleyamlsamples. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/endpoints-v1.adoc#endpoints-v1[`array (Endpoints)`] +| List of endpoints. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="container-core-v1"] -== Container [core/v1] +[id="io.k8s.api.core.v1.EnvVar_v2"] +== io.k8s.api.core.v1.EnvVar_v2 schema Description:: + -- -A single application container that you want to run within a pod. +EnvVar represents an environment variable present in a Container. -- Type:: @@ -2603,186 +2641,106 @@ Required:: - `name` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `args` -| `array (string)` -| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - -| `command` -| `array (string)` -| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - -| `env` -| xref:../objects/index.adoc#envvar-core-v1[`array (EnvVar core/v1)`] -| List of environment variables to set in the container. Cannot be updated. - -| `envFrom` -| xref:../objects/index.adoc#envfromsource-core-v1[`array (EnvFromSource core/v1)`] -| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. - -| `image` -| `string` -| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. - -| `imagePullPolicy` -| `string` -| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - -| `lifecycle` -| xref:../objects/index.adoc#lifecycle-core-v1[`Lifecycle core/v1`] -| Actions that the management system should take in response to container lifecycle events. Cannot be updated. - -| `livenessProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - | `name` | `string` -| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. - -| `ports` -| xref:../objects/index.adoc#containerport-core-v1[`array (ContainerPort core/v1)`] -| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. - -| `readinessProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - -| `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] -| Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - -| `securityContext` -| xref:../objects/index.adoc#securitycontext-core-v1[`SecurityContext core/v1`] -| SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - -| `startupProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - -| `stdin` -| `boolean` -| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. - -| `stdinOnce` -| `boolean` -| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false - -| `terminationMessagePath` -| `string` -| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +| Name of the environment variable. Must be a C_IDENTIFIER. -| `terminationMessagePolicy` +| `value` | `string` -| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. - -| `tty` -| `boolean` -| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. - -| `volumeDevices` -| xref:../objects/index.adoc#volumedevice-core-v1[`array (VolumeDevice core/v1)`] -| volumeDevices is the list of block devices to be used by the container. - -| `volumeMounts` -| xref:../objects/index.adoc#volumemount-core-v1[`array (VolumeMount core/v1)`] -| Pod volumes to mount into the container's filesystem. Cannot be updated. +| Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". -| `workingDir` -| `string` -| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +| `valueFrom` +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVarSource[`EnvVarSource`] +| Source for the environment variable's value. Cannot be used if value is not empty. |=== -[id="containerimage-core-v1"] -== ContainerImage [core/v1] +[id="io.k8s.api.core.v1.EventList"] +== io.k8s.api.core.v1.EventList schema Description:: + -- -Describe a container image +EventList is a list of events. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `names` -| `array (string)` -| Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `sizeBytes` -| `integer` -| The size of the image in bytes. +| `items` +| xref:../metadata_apis/event-v1.adoc#event-v1[`array (Event)`] +| List of events + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="containerport-core-v1"] -== ContainerPort [core/v1] +[id="io.k8s.api.core.v1.EventSource"] +== io.k8s.api.core.v1.EventSource schema Description:: + -- -ContainerPort represents a network port in a single container. +EventSource contains information for an event. -- Type:: `object` -Required:: - - `containerPort` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `containerPort` -| `integer` -| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. - -| `hostIP` -| `string` -| What host IP to bind the external port to. - -| `hostPort` -| `integer` -| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. - -| `name` +| `component` | `string` -| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +| Component from which the event is generated. -| `protocol` +| `host` | `string` -| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +| Node name on which the event is generated. |=== -[id="containerruntimeconfiglist-machineconfiguration-openshift-io-v1"] -== ContainerRuntimeConfigList [machineconfiguration.openshift.io/v1] +[id="io.k8s.api.core.v1.LimitRangeList"] +== io.k8s.api.core.v1.LimitRangeList schema Description:: + -- -ContainerRuntimeConfigList is a list of ContainerRuntimeConfig +LimitRangeList is a list of LimitRange items. -- Type:: @@ -2792,7 +2750,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2803,27 +2761,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`array (ContainerRuntimeConfig machineconfiguration.openshift.io/v1)`] -| List of containerruntimeconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`array (LimitRange)`] +| Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="containerstate-core-v1"] -== ContainerState [core/v1] +[id="io.k8s.api.core.v1.LoadBalancerStatus"] +== io.k8s.api.core.v1.LoadBalancerStatus schema Description:: + -- -ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +LoadBalancerStatus represents the status of a load-balancer. -- Type:: @@ -2831,34 +2789,26 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `running` -| xref:../objects/index.adoc#containerstaterunning-core-v1[`ContainerStateRunning core/v1`] -| Details about a running container - -| `terminated` -| xref:../objects/index.adoc#containerstateterminated-core-v1[`ContainerStateTerminated core/v1`] -| Details about a terminated container - -| `waiting` -| xref:../objects/index.adoc#containerstatewaiting-core-v1[`ContainerStateWaiting core/v1`] -| Details about a waiting container +| `ingress` +| xref:../objects/index.adoc#io.k8s.api.core.v1.LoadBalancerIngress[`array (LoadBalancerIngress)`] +| Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |=== -[id="containerstaterunning-core-v1"] -== ContainerStateRunning [core/v1] +[id="io.k8s.api.core.v1.LocalObjectReference_v2"] +== io.k8s.api.core.v1.LocalObjectReference_v2 schema Description:: + -- -ContainerStateRunning is a running state of a container. +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. -- Type:: @@ -2866,110 +2816,113 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `startedAt` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Time at which the container was last (re-)started +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |=== -[id="containerstateterminated-core-v1"] -== ContainerStateTerminated [core/v1] +[id="io.k8s.api.core.v1.NamespaceCondition"] +== io.k8s.api.core.v1.NamespaceCondition schema Description:: + -- -ContainerStateTerminated is a terminated state of a container. +NamespaceCondition contains details about state of namespace. -- Type:: `object` Required:: - - `exitCode` + - `type` + - `status` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `containerID` -| `string` -| Container's ID in the format 'docker://' - -| `exitCode` -| `integer` -| Exit status from the last termination of the container - -| `finishedAt` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Time at which the container last terminated +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| | `message` | `string` -| Message regarding the last termination of the container +| | `reason` | `string` -| (brief) reason from the last termination of the container +| -| `signal` -| `integer` -| Signal from the last termination of the container +| `status` +| `string` +| Status of the condition, one of True, False, Unknown. -| `startedAt` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Time at which previous execution of the container started +| `type` +| `string` +| Type of namespace controller condition. |=== -[id="containerstatewaiting-core-v1"] -== ContainerStateWaiting [core/v1] +[id="io.k8s.api.core.v1.NamespaceList"] +== io.k8s.api.core.v1.NamespaceList schema Description:: + -- -ContainerStateWaiting is a waiting state of a container. +NamespaceList is a list of Namespaces. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `message` +| `apiVersion` | `string` -| Message regarding why the container is not yet running. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `reason` +| `items` +| xref:../metadata_apis/namespace-v1.adoc#namespace-v1[`array (Namespace)`] +| Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `kind` | `string` -| (brief) reason the container is not yet running. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="controllerconfiglist-machineconfiguration-openshift-io-v1"] -== ControllerConfigList [machineconfiguration.openshift.io/v1] +[id="io.k8s.api.core.v1.NodeList"] +== io.k8s.api.core.v1.NodeList schema Description:: + -- -ControllerConfigList is a list of ControllerConfig +NodeList is the whole list of all Nodes which have been registered with master. -- Type:: @@ -2979,7 +2932,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -2990,37 +2943,35 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`array (ControllerConfig machineconfiguration.openshift.io/v1)`] -| List of controllerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../node_apis/node-v1.adoc#node-v1[`array (Node)`] +| List of nodes | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="controllerrevisionlist-apps-v1"] -== ControllerRevisionList [apps/v1] +[id="io.k8s.api.core.v1.ObjectReference"] +== io.k8s.api.core.v1.ObjectReference schema Description:: + -- -ControllerRevisionList is a resource containing a list of ControllerRevision objects. +ObjectReference contains enough information to let you inspect or modify the referred object. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3028,40 +2979,50 @@ Required:: | `apiVersion` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| API version of the referent. -| `items` -| xref:../metadata_apis/controllerrevision-apps-v1.adoc#controllerrevision-apps-v1[`array (ControllerRevision apps/v1)`] -| Items is the list of ControllerRevisions +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | `kind` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -[id="credentialsrequestlist-cloudcredential-openshift-io-v1"] -== CredentialsRequestList [cloudcredential.openshift.io/v1] +[id="io.k8s.api.core.v1.ObjectReference_v2"] +== io.k8s.api.core.v1.ObjectReference_v2 schema Description:: + -- -CredentialsRequestList is a list of CredentialsRequest +ObjectReference contains enough information to let you inspect or modify the referred object. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3069,40 +3030,50 @@ Required:: | `apiVersion` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| API version of the referent. -| `items` -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`array (CredentialsRequest cloudcredential.openshift.io/v1)`] -| List of credentialsrequests. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | `kind` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -[id="cronjoblist-batch-v1"] -== CronJobList [batch/v1] +[id="io.k8s.api.core.v1.PersistentVolumeClaim"] +== io.k8s.api.core.v1.PersistentVolumeClaim schema Description:: + -- -CronJobList is a collection of cron jobs. +PersistentVolumeClaim is a user's request for and claim to a persistent volume -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3112,299 +3083,262 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`array (CronJob batch/v1)`] -| items is the list of CronJobs. - | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -[id="csidriverlist-storage-k8s-io-v1"] -== CSIDriverList [storage.k8s.io/v1] +| `spec` +| `object` +| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +| `status` +| `object` +| PersistentVolumeClaimStatus is the current status of a persistent volume claim. +|=== +..spec Description:: + -- -CSIDriverList is a collection of CSIDriver objects. +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes -- Type:: `object` -Required:: - - `items` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `accessModes` +| `array (string)` +| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 -| `items` -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`array (CSIDriver storage.k8s.io/v1)`] -| items is the list of CSIDriver +| `dataSource` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `dataSourceRef` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. -|=== +| `selector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over volumes to consider for binding. + +| `storageClassName` +| `string` +| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 -[id="csinodelist-storage-k8s-io-v1"] -== CSINodeList [storage.k8s.io/v1] +| `volumeMode` +| `string` +| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. +| `volumeName` +| `string` +| VolumeName is the binding reference to the PersistentVolume backing this claim. +|=== +..spec.dataSource Description:: + -- -CSINodeList is a collection of CSINode objects. +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. -- Type:: `object` Required:: - - `items` + - `kind` + - `name` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` +| `apiGroup` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`array (CSINode storage.k8s.io/v1)`] -| items is the list of CSINode +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | `kind` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| Kind is the type of resource being referenced -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `name` +| `string` +| Name is the name of resource being referenced |=== - -[id="csipersistentvolumesource-core-v1"] -== CSIPersistentVolumeSource [core/v1] - - +..spec.dataSourceRef Description:: + -- -Represents storage that is managed by an external CSI volume driver (Beta feature) +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. -- Type:: `object` Required:: - - `driver` - - `volumeHandle` + - `kind` + - `name` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `controllerExpandSecretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - -| `controllerPublishSecretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - -| `driver` +| `apiGroup` | `string` -| Driver is the name of the driver to use for this volume. Required. +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. -| `fsType` +| `kind` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". - -| `nodePublishSecretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - -| `nodeStageSecretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. - -| `readOnly` -| `boolean` -| Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). - -| `volumeAttributes` -| `object (string)` -| Attributes of the volume to publish. +| Kind is the type of resource being referenced -| `volumeHandle` +| `name` | `string` -| VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. +| Name is the name of resource being referenced |=== - -[id="csisnapshotcontrollerlist-operator-openshift-io-v1"] -== CSISnapshotControllerList [operator.openshift.io/v1] - - +..spec.resources Description:: + -- -CSISnapshotControllerList is a list of CSISnapshotController +ResourceRequirements describes the compute resource requirements. -- Type:: `object` -Required:: - - `items` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`array (CSISnapshotController operator.openshift.io/v1)`] -| List of csisnapshotcontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== - -[id="csistoragecapacitylist-storage-k8s-io-v1beta1"] -== CSIStorageCapacityList [storage.k8s.io/v1beta1] - - +..status Description:: + -- -CSIStorageCapacityList is a collection of CSIStorageCapacity objects. +PersistentVolumeClaimStatus is the current status of a persistent volume claim. -- Type:: `object` -Required:: - - `items` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `accessModes` +| `array (string)` +| AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 -| `items` -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`array (CSIStorageCapacity storage.k8s.io/v1beta1)`] -| Items is the list of CSIStorageCapacity objects. +| `capacity` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Represents the actual resources of the underlying volume. -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `conditions` +| `array` +| Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `conditions[]` +| `object` +| PersistentVolumeClaimCondition contails details about state of pvc + +| `phase` +| `string` +| Phase represents the current phase of PersistentVolumeClaim. |=== +..status.conditions +Description:: ++ +-- +Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. +-- -[id="csivolumesource-core-v1"] -== CSIVolumeSource [core/v1] +Type:: + `array` +..status.conditions[] Description:: + -- -Represents a source location of a volume to mount, managed by an external CSI driver +PersistentVolumeClaimCondition contails details about state of pvc -- Type:: `object` Required:: - - `driver` + - `type` + - `status` -[discrete] -=== Specification [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `driver` -| `string` -| Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. +| `lastProbeTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time we probed the condition. + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time the condition transitioned from one status to another. -| `fsType` +| `message` | `string` -| Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. +| Human-readable message indicating details about last transition. -| `nodePublishSecretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. +| `reason` +| `string` +| Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. -| `readOnly` -| `boolean` -| Specifies a read-only configuration for the volume. Defaults to false (read/write). +| `status` +| `string` +| -| `volumeAttributes` -| `object (string)` -| VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +| `type` +| `string` +| |=== -[id="customresourcedefinitionlist-apiextensions-k8s-io-v1"] -== CustomResourceDefinitionList [apiextensions.k8s.io/v1] +[id="io.k8s.api.core.v1.PersistentVolumeClaimList"] +== io.k8s.api.core.v1.PersistentVolumeClaimList schema Description:: + -- -CustomResourceDefinitionList is a list of CustomResourceDefinition objects. +PersistentVolumeClaimList is a list of PersistentVolumeClaim items. -- Type:: @@ -3414,7 +3348,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3425,156 +3359,221 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`array (CustomResourceDefinition apiextensions.k8s.io/v1)`] -| items list individual CustomResourceDefinition objects +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`array (PersistentVolumeClaim)`] +| A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="daemonendpoint-core-v1"] -== DaemonEndpoint [core/v1] +[id="io.k8s.api.core.v1.PersistentVolumeList"] +== io.k8s.api.core.v1.PersistentVolumeList schema Description:: + -- -DaemonEndpoint contains information about a single Daemon endpoint. +PersistentVolumeList is a list of PersistentVolume items. -- Type:: `object` Required:: - - `Port` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `Port` -| `integer` -| Port number of the given endpoint. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`array (PersistentVolume)`] +| List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="daemonsetlist-apps-v1"] -== DaemonSetList [apps/v1] +[id="io.k8s.api.core.v1.PersistentVolumeSpec"] +== io.k8s.api.core.v1.PersistentVolumeSpec schema Description:: + -- -DaemonSetList is a collection of daemon sets. +PersistentVolumeSpec is the specification of a persistent volume. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `accessModes` +| `array (string)` +| AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes -| `items` -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`array (DaemonSet apps/v1)`] -| A list of daemon sets. +| `awsElasticBlockStore` +| xref:../objects/index.adoc#io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource[`AWSElasticBlockStoreVolumeSource`] +| AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `azureDisk` +| xref:../objects/index.adoc#io.k8s.api.core.v1.AzureDiskVolumeSource[`AzureDiskVolumeSource`] +| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `azureFile` +| xref:../objects/index.adoc#io.k8s.api.core.v1.AzureFilePersistentVolumeSource[`AzureFilePersistentVolumeSource`] +| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. -|=== +| `capacity` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity -[id="deleteoptions-meta-v1"] -== DeleteOptions [meta/v1] +| `cephfs` +| xref:../objects/index.adoc#io.k8s.api.core.v1.CephFSPersistentVolumeSource[`CephFSPersistentVolumeSource`] +| CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +| `cinder` +| xref:../objects/index.adoc#io.k8s.api.core.v1.CinderPersistentVolumeSource[`CinderPersistentVolumeSource`] +| Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md -Description:: -+ --- -DeleteOptions may be provided when deleting an API object. --- +| `claimRef` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference[`ObjectReference`] +| ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding -Type:: - `object` +| `csi` +| xref:../objects/index.adoc#io.k8s.api.core.v1.CSIPersistentVolumeSource[`CSIPersistentVolumeSource`] +| CSI represents storage that is handled by an external CSI driver (Beta feature). +| `fc` +| xref:../objects/index.adoc#io.k8s.api.core.v1.FCVolumeSource[`FCVolumeSource`] +| FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. -[discrete] -=== Specification +| `flexVolume` +| xref:../objects/index.adoc#io.k8s.api.core.v1.FlexPersistentVolumeSource[`FlexPersistentVolumeSource`] +| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `flocker` +| xref:../objects/index.adoc#io.k8s.api.core.v1.FlockerVolumeSource[`FlockerVolumeSource`] +| Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `gcePersistentDisk` +| xref:../objects/index.adoc#io.k8s.api.core.v1.GCEPersistentDiskVolumeSource[`GCEPersistentDiskVolumeSource`] +| GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk -| `dryRun` +| `glusterfs` +| xref:../objects/index.adoc#io.k8s.api.core.v1.GlusterfsPersistentVolumeSource[`GlusterfsPersistentVolumeSource`] +| Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md + +| `hostPath` +| xref:../objects/index.adoc#io.k8s.api.core.v1.HostPathVolumeSource[`HostPathVolumeSource`] +| HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +| `iscsi` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ISCSIPersistentVolumeSource[`ISCSIPersistentVolumeSource`] +| ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. + +| `local` +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalVolumeSource[`LocalVolumeSource`] +| Local represents directly-attached storage with node affinity + +| `mountOptions` | `array (string)` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options -| `gracePeriodSeconds` -| `integer` -| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `nfs` +| xref:../objects/index.adoc#io.k8s.api.core.v1.NFSVolumeSource[`NFSVolumeSource`] +| NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs -| `kind` +| `nodeAffinity` +| xref:../objects/index.adoc#io.k8s.api.core.v1.VolumeNodeAffinity[`VolumeNodeAffinity`] +| NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. + +| `persistentVolumeReclaimPolicy` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming -| `orphanDependents` -| `boolean` -| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `photonPersistentDisk` +| xref:../objects/index.adoc#io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource[`PhotonPersistentDiskVolumeSource`] +| PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine -| `preconditions` -| xref:../objects/index.adoc#preconditions-meta-v1[`Preconditions meta/v1`] -| Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. +| `portworxVolume` +| xref:../objects/index.adoc#io.k8s.api.core.v1.PortworxVolumeSource[`PortworxVolumeSource`] +| PortworxVolume represents a portworx volume attached and mounted on kubelets host machine -| `propagationPolicy` +| `quobyte` +| xref:../objects/index.adoc#io.k8s.api.core.v1.QuobyteVolumeSource[`QuobyteVolumeSource`] +| Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + +| `rbd` +| xref:../objects/index.adoc#io.k8s.api.core.v1.RBDPersistentVolumeSource[`RBDPersistentVolumeSource`] +| RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + +| `scaleIO` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ScaleIOPersistentVolumeSource[`ScaleIOPersistentVolumeSource`] +| ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + +| `storageClassName` | `string` -| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. + +| `storageos` +| xref:../objects/index.adoc#io.k8s.api.core.v1.StorageOSPersistentVolumeSource[`StorageOSPersistentVolumeSource`] +| StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md + +| `volumeMode` +| `string` +| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. + +| `vsphereVolume` +| xref:../objects/index.adoc#io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource[`VsphereVirtualDiskVolumeSource`] +| VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -[id="deleteoptions_v2-meta-v1"] -== DeleteOptions_v2 [meta/v1] +[id="io.k8s.api.core.v1.PodList"] +== io.k8s.api.core.v1.PodList schema Description:: + -- -DeleteOptions may be provided when deleting an API object. +PodList is a list of Pods. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3584,40 +3583,28 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `dryRun` -| `array (string)` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed - -| `gracePeriodSeconds` -| `integer` -| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `items` +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`array (Pod)`] +| List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `orphanDependents` -| `boolean` -| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - -| `preconditions` -| xref:../objects/index.adoc#preconditions-meta-v1[`Preconditions meta/v1`] -| Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. - -| `propagationPolicy` -| `string` -| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="deploymentconfiglist-apps-openshift-io-v1"] -== DeploymentConfigList [apps.openshift.io/v1] +[id="io.k8s.api.core.v1.PodTemplateList"] +== io.k8s.api.core.v1.PodTemplateList schema Description:: + -- -DeploymentConfigList is a collection of deployment configs. +PodTemplateList is a list of PodTemplates. -- Type:: @@ -3627,7 +3614,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3638,73 +3625,58 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`array (DeploymentConfig apps.openshift.io/v1)`] -| Items is a list of deployment configs +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`array (PodTemplate)`] +| List of pod templates | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="deploymentconfigrollback-apps-openshift-io-v1"] -== DeploymentConfigRollback [apps.openshift.io/v1] +[id="io.k8s.api.core.v1.PodTemplateSpec"] +== io.k8s.api.core.v1.PodTemplateSpec schema Description:: + -- -DeploymentConfigRollback provides the input to rollback generation. +PodTemplateSpec describes the data a pod should have when created from a template -- Type:: `object` -Required:: - - `name` - - `spec` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `name` -| `string` -| Name of the deployment config that will be rolled back. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` -| xref:../objects/index.adoc#deploymentconfigrollbackspec-apps-openshift-io-v1[`DeploymentConfigRollbackSpec apps.openshift.io/v1`] -| Spec defines the options to rollback generation. - -| `updatedAnnotations` -| `object (string)` -| UpdatedAnnotations is a set of new annotations that will be added in the deployment config. +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodSpec[`PodSpec`] +| Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -[id="deploymentlist-apps-v1"] -== DeploymentList [apps/v1] +[id="io.k8s.api.core.v1.ReplicationControllerList"] +== io.k8s.api.core.v1.ReplicationControllerList schema Description:: + -- -DeploymentList is a list of Deployments. +ReplicationControllerList is a collection of replication controllers. -- Type:: @@ -3714,7 +3686,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3725,35 +3697,37 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`array (Deployment apps/v1)`] -| Items is the list of Deployments. +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`array (ReplicationController)`] +| List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="deploymentlog-apps-openshift-io-v1"] -== DeploymentLog [apps.openshift.io/v1] +[id="io.k8s.api.core.v1.ResourceQuotaList"] +== io.k8s.api.core.v1.ResourceQuotaList schema Description:: + -- -DeploymentLog represents the logs for a deployment +ResourceQuotaList is a list of ResourceQuota items. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3763,163 +3737,133 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`array (ResourceQuota)`] +| Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + |=== -[id="deploymentrequest-apps-openshift-io-v1"] -== DeploymentRequest [apps.openshift.io/v1] +[id="io.k8s.api.core.v1.ResourceQuotaSpec"] +== io.k8s.api.core.v1.ResourceQuotaSpec schema Description:: + -- -DeploymentRequest is a request to a deployment config for a new deployment. +ResourceQuotaSpec defines the desired hard limits to enforce for Quota. -- Type:: `object` -Required:: - - `name` - - `latest` - - `force` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `excludeTriggers` -| `array (string)` -| ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified. - -| `force` -| `boolean` -| Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `hard` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ -| `latest` -| `boolean` -| Latest will update the deployment config with the latest state from all triggers. +| `scopeSelector` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ScopeSelector[`ScopeSelector`] +| scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. -| `name` -| `string` -| Name of the deployment config for requesting a new deployment. +| `scopes` +| `array (string)` +| A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |=== -[id="dnslist-config-openshift-io-v1"] -== DNSList [config.openshift.io/v1] +[id="io.k8s.api.core.v1.ResourceQuotaStatus"] +== io.k8s.api.core.v1.ResourceQuotaStatus schema Description:: + -- -DNSList is a list of DNS +ResourceQuotaStatus defines the enforced hard limits and observed use. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`array (DNS config.openshift.io/v1)`] -| List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `hard` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `used` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Used is the current observed total usage of the resource in the namespace. |=== -[id="dnslist-operator-openshift-io-v1"] -== DNSList [operator.openshift.io/v1] +[id="io.k8s.api.core.v1.ResourceRequirements"] +== io.k8s.api.core.v1.ResourceRequirements schema Description:: + -- -DNSList is a list of DNS +ResourceRequirements describes the compute resource requirements. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`array (DNS operator.openshift.io/v1)`] -| List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -[id="dnsrecordlist-ingress-operator-openshift-io-v1"] -== DNSRecordList [ingress.operator.openshift.io/v1] +[id="io.k8s.api.core.v1.Secret"] +== io.k8s.api.core.v1.Secret schema Description:: + -- -DNSRecordList is a list of DNSRecord +Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -3929,96 +3873,83 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`array (DNSRecord ingress.operator.openshift.io/v1)`] -| List of dnsrecords. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `data` +| `object (string)` +| Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + +| `immutable` +| `boolean` +| Immutable, if set to true, ensures that data stored in the Secret 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. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `stringData` +| `object (string)` +| stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. + +| `type` +| `string` +| Used to facilitate programmatic handling of secret data. |=== -[id="downwardapiprojection-core-v1"] -== DownwardAPIProjection [core/v1] +[id="io.k8s.api.core.v1.SecretList"] +== io.k8s.api.core.v1.SecretList schema Description:: + -- -Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `items` -| xref:../objects/index.adoc#downwardapivolumefile-core-v1[`array (DownwardAPIVolumeFile core/v1)`] -| Items is a list of DownwardAPIVolume file - -|=== - -[id="downwardapivolumefile-core-v1"] -== DownwardAPIVolumeFile [core/v1] - - -Description:: -+ --- -DownwardAPIVolumeFile represents information to create the file containing the pod field +SecretList is a list of Secret. -- Type:: `object` Required:: - - `path` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fieldRef` -| xref:../objects/index.adoc#objectfieldselector-core-v1[`ObjectFieldSelector core/v1`] -| Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `mode` -| `integer` -| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +| `items` +| xref:../security_apis/secret-v1.adoc#secret-v1[`array (Secret)`] +| Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret -| `path` +| `kind` | `string` -| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `resourceFieldRef` -| xref:../objects/index.adoc#resourcefieldselector-core-v1[`ResourceFieldSelector core/v1`] -| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="downwardapivolumesource-core-v1"] -== DownwardAPIVolumeSource [core/v1] +[id="io.k8s.api.core.v1.SecretVolumeSource"] +== io.k8s.api.core.v1.SecretVolumeSource schema Description:: + -- -DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. +Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. -- Type:: @@ -4026,7 +3957,7 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4034,22 +3965,30 @@ Type:: | `defaultMode` | `integer` -| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | `items` -| xref:../objects/index.adoc#downwardapivolumefile-core-v1[`array (DownwardAPIVolumeFile core/v1)`] -| Items is a list of downward API volume file +| xref:../objects/index.adoc#io.k8s.api.core.v1.KeyToPath[`array (KeyToPath)`] +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `optional` +| `boolean` +| Specify whether the Secret or its keys must be defined + +| `secretName` +| `string` +| Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -[id="egressnetworkpolicylist-network-openshift-io-v1"] -== EgressNetworkPolicyList [network.openshift.io/v1] +[id="io.k8s.api.core.v1.ServiceAccountList"] +== io.k8s.api.core.v1.ServiceAccountList schema Description:: + -- -EgressNetworkPolicyList is a list of EgressNetworkPolicy +ServiceAccountList is a list of ServiceAccount objects -- Type:: @@ -4059,7 +3998,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4070,27 +4009,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`array (EgressNetworkPolicy network.openshift.io/v1)`] -| List of egressnetworkpolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`array (ServiceAccount)`] +| List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="egressrouterlist-network-operator-openshift-io-v1"] -== EgressRouterList [network.operator.openshift.io/v1] +[id="io.k8s.api.core.v1.ServiceList"] +== io.k8s.api.core.v1.ServiceList schema Description:: + -- -EgressRouterList is a list of EgressRouter +ServiceList holds a list of services. -- Type:: @@ -4100,7 +4039,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4111,27 +4050,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`array (EgressRouter network.operator.openshift.io/v1)`] -| List of egressrouters. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/service-v1.adoc#service-v1[`array (Service)`] +| List of services | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="emptydirvolumesource-core-v1"] -== EmptyDirVolumeSource [core/v1] +[id="io.k8s.api.core.v1.Toleration"] +== io.k8s.api.core.v1.Toleration schema Description:: + -- -Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . -- Type:: @@ -4139,106 +4078,101 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `medium` +| `effect` +| `string` +| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + +| `key` +| `string` +| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + +| `operator` | `string` -| What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir +| Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. -| `sizeLimit` -| xref:../objects/index.adoc#quantity-api-none[`Quantity api/none`] -| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir +| `tolerationSeconds` +| `integer` +| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + +| `value` +| `string` +| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -[id="endpointaddress-core-v1"] -== EndpointAddress [core/v1] +[id="io.k8s.api.core.v1.TopologySelectorTerm"] +== io.k8s.api.core.v1.TopologySelectorTerm schema Description:: + -- -EndpointAddress is a tuple that describes single IP address. +A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. -- Type:: `object` -Required:: - - `ip` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `hostname` -| `string` -| The Hostname of this endpoint - -| `ip` -| `string` -| The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. - -| `nodeName` -| `string` -| Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. - -| `targetRef` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] -| Reference to object providing the endpoint. +| `matchLabelExpressions` +| xref:../objects/index.adoc#io.k8s.api.core.v1.TopologySelectorLabelRequirement[`array (TopologySelectorLabelRequirement)`] +| A list of topology selector requirements by labels. |=== -[id="endpointport-core-v1"] -== EndpointPort [core/v1] +[id="io.k8s.api.core.v1.TypedLocalObjectReference"] +== io.k8s.api.core.v1.TypedLocalObjectReference schema Description:: + -- -EndpointPort is a tuple that describes a single port. +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. -- Type:: `object` Required:: - - `port` + - `kind` + - `name` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `appProtocol` +| `apiGroup` | `string` -| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. -| `name` +| `kind` | `string` -| The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. - -| `port` -| `integer` -| The port number of the endpoint. +| Kind is the type of resource being referenced -| `protocol` +| `name` | `string` -| The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. +| Name is the name of resource being referenced |=== -[id="endpointslicelist-discovery-k8s-io-v1"] -== EndpointSliceList [discovery.k8s.io/v1] +[id="io.k8s.api.discovery.v1.EndpointSliceList"] +== io.k8s.api.discovery.v1.EndpointSliceList schema Description:: @@ -4254,7 +4188,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4265,7 +4199,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`array (EndpointSlice discovery.k8s.io/v1)`] +| xref:../network_apis/endpointslice-discovery-k8s-io-v1.adoc#endpointslice-discovery-k8s-io-v1[`array (EndpointSlice)`] | List of endpoint slices | `kind` @@ -4273,19 +4207,19 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. |=== -[id="endpointslist-core-v1"] -== EndpointsList [core/v1] +[id="io.k8s.api.events.v1.EventList"] +== io.k8s.api.events.v1.EventList schema Description:: + -- -EndpointsList is a list of endpoints. +EventList is a list of Event objects. -- Type:: @@ -4295,7 +4229,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4306,334 +4240,314 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/endpoints-core-v1.adoc#endpoints-core-v1[`array (Endpoints core/v1)`] -| List of endpoints. +| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`array (Event)`] +| items is a list of schema objects. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="endpointsubset-core-v1"] -== EndpointSubset [core/v1] +[id="io.k8s.api.flowcontrol.v1beta1.FlowSchemaList"] +== io.k8s.api.flowcontrol.v1beta1.FlowSchemaList schema Description:: + -- -EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - } -The resulting set of endpoints can be viewed as: - a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], - b: [ 10.10.1.1:309, 10.10.2.2:309 ] +FlowSchemaList is a list of FlowSchema objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `addresses` -| xref:../objects/index.adoc#endpointaddress-core-v1[`array (EndpointAddress core/v1)`] -| IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`array (FlowSchema)`] +| `items` is a list of FlowSchemas. -| `notReadyAddresses` -| xref:../objects/index.adoc#endpointaddress-core-v1[`array (EndpointAddress core/v1)`] -| IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `ports` -| xref:../objects/index.adoc#endpointport-core-v1[`array (EndpointPort core/v1)`] -| Port numbers available on the related IP addresses. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="envfromsource-core-v1"] -== EnvFromSource [core/v1] +[id="io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList"] +== io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList schema Description:: + -- -EnvFromSource represents the source of a set of ConfigMaps +PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `configMapRef` -| xref:../objects/index.adoc#configmapenvsource-core-v1[`ConfigMapEnvSource core/v1`] -| The ConfigMap to select from +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`array (PriorityLevelConfiguration)`] +| `items` is a list of request-priorities. -| `prefix` +| `kind` | `string` -| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `secretRef` -| xref:../objects/index.adoc#secretenvsource-core-v1[`SecretEnvSource core/v1`] -| The Secret to select from +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="envvar-core-v1"] -== EnvVar [core/v1] +[id="io.k8s.api.networking.v1.IngressClassList"] +== io.k8s.api.networking.v1.IngressClassList schema Description:: + -- -EnvVar represents an environment variable present in a Container. +IngressClassList is a collection of IngressClasses. -- Type:: `object` Required:: - - `name` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name of the environment variable. Must be a C_IDENTIFIER. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `value` +| `items` +| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`array (IngressClass)`] +| Items is the list of IngressClasses. + +| `kind` | `string` -| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `valueFrom` -| xref:../objects/index.adoc#envvarsource-core-v1[`EnvVarSource core/v1`] -| Source for the environment variable's value. Cannot be used if value is not empty. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. |=== -[id="envvar_v2-core-v1"] -== EnvVar_v2 [core/v1] +[id="io.k8s.api.networking.v1.IngressList"] +== io.k8s.api.networking.v1.IngressList schema Description:: + -- -EnvVar represents an environment variable present in a Container. +IngressList is a collection of Ingress. -- Type:: `object` Required:: - - `name` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name of the environment variable. Must be a C_IDENTIFIER. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `value` +| `items` +| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`array (Ingress)`] +| Items is the list of Ingress. + +| `kind` | `string` -| Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `valueFrom` -| xref:../objects/index.adoc#envvarsource-core-v1[`EnvVarSource core/v1`] -| Source for the environment variable's value. Cannot be used if value is not empty. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="envvarsource-core-v1"] -== EnvVarSource [core/v1] +[id="io.k8s.api.networking.v1.NetworkPolicyList"] +== io.k8s.api.networking.v1.NetworkPolicyList schema Description:: + -- -EnvVarSource represents a source for the value of an EnvVar. +NetworkPolicyList is a list of NetworkPolicy objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `configMapKeyRef` -| xref:../objects/index.adoc#configmapkeyselector-core-v1[`ConfigMapKeySelector core/v1`] -| Selects a key of a ConfigMap. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `fieldRef` -| xref:../objects/index.adoc#objectfieldselector-core-v1[`ObjectFieldSelector core/v1`] -| Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. +| `items` +| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`array (NetworkPolicy)`] +| Items is a list of schema objects. -| `resourceFieldRef` -| xref:../objects/index.adoc#resourcefieldselector-core-v1[`ResourceFieldSelector core/v1`] -| Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `secretKeyRef` -| xref:../objects/index.adoc#secretkeyselector-core-v1[`SecretKeySelector core/v1`] -| Selects a key of a secret in the pod's namespace +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="ephemeralcontainer-core-v1"] -== EphemeralContainer [core/v1] +[id="io.k8s.api.node.v1.RuntimeClassList"] +== io.k8s.api.node.v1.RuntimeClassList schema Description:: + -- -An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. +RuntimeClassList is a list of RuntimeClass objects. -- Type:: `object` Required:: - - `name` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `args` -| `array (string)` -| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - -| `command` -| `array (string)` -| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - -| `env` -| xref:../objects/index.adoc#envvar-core-v1[`array (EnvVar core/v1)`] -| List of environment variables to set in the container. Cannot be updated. - -| `envFrom` -| xref:../objects/index.adoc#envfromsource-core-v1[`array (EnvFromSource core/v1)`] -| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. - -| `image` -| `string` -| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images - -| `imagePullPolicy` +| `apiVersion` | `string` -| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - -| `lifecycle` -| xref:../objects/index.adoc#lifecycle-core-v1[`Lifecycle core/v1`] -| Lifecycle is not allowed for ephemeral containers. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `livenessProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| Probes are not allowed for ephemeral containers. +| `items` +| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`array (RuntimeClass)`] +| Items is a list of schema objects. -| `name` +| `kind` | `string` -| Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `ports` -| xref:../objects/index.adoc#containerport-core-v1[`array (ContainerPort core/v1)`] -| Ports are not allowed for ephemeral containers. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -| `readinessProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| Probes are not allowed for ephemeral containers. +|=== -| `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] -| Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. +[id="io.k8s.api.policy.v1.PodDisruptionBudgetList"] +== io.k8s.api.policy.v1.PodDisruptionBudgetList schema -| `securityContext` -| xref:../objects/index.adoc#securitycontext-core-v1[`SecurityContext core/v1`] -| Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. -| `startupProbe` -| xref:../objects/index.adoc#probe-core-v1[`Probe core/v1`] -| Probes are not allowed for ephemeral containers. +Description:: ++ +-- +PodDisruptionBudgetList is a collection of PodDisruptionBudgets. +-- -| `stdin` -| `boolean` -| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +Type:: + `object` -| `stdinOnce` -| `boolean` -| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +Required:: + - `items` -| `targetContainerName` -| `string` -| If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. +[discrete] +=== Schema -| `terminationMessagePath` -| `string` -| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description -| `terminationMessagePolicy` +| `apiVersion` | `string` -| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. - -| `tty` -| `boolean` -| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. - -| `volumeDevices` -| xref:../objects/index.adoc#volumedevice-core-v1[`array (VolumeDevice core/v1)`] -| volumeDevices is the list of block devices to be used by the container. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `volumeMounts` -| xref:../objects/index.adoc#volumemount-core-v1[`array (VolumeMount core/v1)`] -| Pod volumes to mount into the container's filesystem. Cannot be updated. +| `items` +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`array (PodDisruptionBudget)`] +| Items is a list of PodDisruptionBudgets -| `workingDir` +| `kind` | `string` -| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="ephemeralvolumesource-core-v1"] -== EphemeralVolumeSource [core/v1] +[id="io.k8s.api.rbac.v1.AggregationRule"] +== io.k8s.api.rbac.v1.AggregationRule schema Description:: + -- -Represents an ephemeral volume that is handled by a normal storage driver. +AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole -- Type:: @@ -4641,32 +4555,26 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `volumeClaimTemplate` -| xref:../objects/index.adoc#persistentvolumeclaimtemplate-core-v1[`PersistentVolumeClaimTemplate core/v1`] -| Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). - -An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. - -This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. - -Required, must not be nil. +| `clusterRoleSelectors` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`array (LabelSelector)`] +| ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added |=== -[id="etcdlist-operator-openshift-io-v1"] -== EtcdList [operator.openshift.io/v1] +[id="io.k8s.api.rbac.v1.ClusterRoleBindingList"] +== io.k8s.api.rbac.v1.ClusterRoleBindingList schema Description:: + -- -EtcdList is a list of Etcd +ClusterRoleBindingList is a collection of ClusterRoleBindings -- Type:: @@ -4676,7 +4584,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4687,27 +4595,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`array (Etcd operator.openshift.io/v1)`] -| List of etcds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`array (ClusterRoleBinding)`] +| Items is a list of ClusterRoleBindings | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. |=== -[id="eventlist-core-v1"] -== EventList [core/v1] +[id="io.k8s.api.rbac.v1.ClusterRoleList"] +== io.k8s.api.rbac.v1.ClusterRoleList schema Description:: + -- -EventList is a list of events. +ClusterRoleList is a collection of ClusterRoles -- Type:: @@ -4717,7 +4625,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4728,27 +4636,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../metadata_apis/event-core-v1.adoc#event-core-v1[`array (Event core/v1)`] -| List of events +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`array (ClusterRole)`] +| Items is a list of ClusterRoles | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. |=== -[id="eventlist-events-k8s-io-v1"] -== EventList [events.k8s.io/v1] +[id="io.k8s.api.rbac.v1.RoleBindingList"] +== io.k8s.api.rbac.v1.RoleBindingList schema Description:: + -- -EventList is a list of Event objects. +RoleBindingList is a collection of RoleBindings -- Type:: @@ -4758,7 +4666,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4769,97 +4677,119 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../metadata_apis/event-events-k8s-io-v1.adoc#event-events-k8s-io-v1[`array (Event events.k8s.io/v1)`] -| items is a list of schema objects. +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`array (RoleBinding)`] +| Items is a list of RoleBindings | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. |=== -[id="eventseries-core-v1"] -== EventSeries [core/v1] +[id="io.k8s.api.rbac.v1.RoleList"] +== io.k8s.api.rbac.v1.RoleList schema Description:: + -- -EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. +RoleList is a collection of Roles -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `count` -| `integer` -| Number of occurrences in this series up to the last heartbeat time +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`array (Role)`] +| Items is a list of Roles + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `lastObservedTime` -| xref:../objects/index.adoc#microtime-meta-v1[`MicroTime meta/v1`] -| Time of the last occurrence observed +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata. |=== -[id="eventsource-core-v1"] -== EventSource [core/v1] +[id="io.k8s.api.scheduling.v1.PriorityClassList"] +== io.k8s.api.scheduling.v1.PriorityClassList schema Description:: + -- -EventSource contains information for an event. +PriorityClassList is a collection of priority classes. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `component` +| `apiVersion` | `string` -| Component from which the event is generated. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `host` +| `items` +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`array (PriorityClass)`] +| items is the list of PriorityClasses + +| `kind` | `string` -| Node name on which the event is generated. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="eviction-policy-v1"] -== Eviction [policy/v1] +[id="io.k8s.api.storage.v1.CSIDriverList"] +== io.k8s.api.storage.v1.CSIDriverList schema Description:: + -- -Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. +CSIDriverList is a collection of CSIDriver objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4869,98 +4799,110 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `deleteOptions` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] -| DeleteOptions may be provided +| `items` +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`array (CSIDriver)`] +| items is the list of CSIDriver | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| ObjectMeta describes the pod that is being evicted. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="execaction-core-v1"] -== ExecAction [core/v1] +[id="io.k8s.api.storage.v1.CSINodeList"] +== io.k8s.api.storage.v1.CSINodeList schema Description:: + -- -ExecAction describes a "run in container" action. +CSINodeList is a collection of CSINode objects. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `command` -| `array (string)` -| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`array (CSINode)`] +| items is the list of CSINode + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="fcvolumesource-core-v1"] -== FCVolumeSource [core/v1] +[id="io.k8s.api.storage.v1.StorageClassList"] +== io.k8s.api.storage.v1.StorageClassList schema Description:: + -- -Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. +StorageClassList is a collection of storage classes. -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - -| `lun` -| `integer` -| Optional: FC target lun number +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| `items` +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`array (StorageClass)`] +| Items is the list of StorageClasses -| `targetWWNs` -| `array (string)` -| Optional: FC target worldwide names (WWNs) +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `wwids` -| `array (string)` -| Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="featuregatelist-config-openshift-io-v1"] -== FeatureGateList [config.openshift.io/v1] +[id="io.k8s.api.storage.v1.VolumeAttachmentList"] +== io.k8s.api.storage.v1.VolumeAttachmentList schema Description:: + -- -FeatureGateList is a list of FeatureGate +VolumeAttachmentList is a collection of VolumeAttachment objects. -- Type:: @@ -4970,7 +4912,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -4981,136 +4923,109 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`array (FeatureGate config.openshift.io/v1)`] -| List of featuregates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`array (VolumeAttachment)`] +| Items is the list of VolumeAttachments | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="fieldsv1-meta-v1"] -== FieldsV1 [meta/v1] - - -Description:: -+ --- -FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. - -Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. - -The exact format is defined in sigs.k8s.io/structured-merge-diff --- - -Type:: - `object` - - - -[id="flexpersistentvolumesource-core-v1"] -== FlexPersistentVolumeSource [core/v1] +[id="io.k8s.api.storage.v1beta1.CSIStorageCapacityList"] +== io.k8s.api.storage.v1beta1.CSIStorageCapacityList schema Description:: + -- -FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. +CSIStorageCapacityList is a collection of CSIStorageCapacity objects. -- Type:: `object` Required:: - - `driver` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `driver` -| `string` -| Driver is the name of the driver to use for this volume. - -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `options` -| `object (string)` -| Optional: Extra command options if any. +| `items` +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`array (CSIStorageCapacity)`] +| Items is the list of CSIStorageCapacity objects. -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="flexvolumesource-core-v1"] -== FlexVolumeSource [core/v1] +[id="io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList"] +== io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList schema Description:: + -- -FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +CustomResourceDefinitionList is a list of CustomResourceDefinition objects. -- Type:: `object` Required:: - - `driver` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `driver` -| `string` -| Driver is the name of the driver to use for this volume. - -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `options` -| `object (string)` -| Optional: Extra command options if any. +| `items` +| xref:../extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc#customresourcedefinition-apiextensions-k8s-io-v1[`array (CustomResourceDefinition)`] +| items list individual CustomResourceDefinition objects -| `readOnly` -| `boolean` -| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="flockervolumesource-core-v1"] -== FlockerVolumeSource [core/v1] +[id="io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps"] +== io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps schema Description:: + -- -Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. +JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). -- Type:: @@ -5118,358 +5033,335 @@ Type:: [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `datasetName` +| `$ref` | `string` -| Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +| -| `datasetUUID` +| `$schema` | `string` -| UUID of the dataset. This is unique identifier of a Flocker dataset - -|=== +| -[id="flowschemalist-flowcontrol-apiserver-k8s-io-v1beta1"] -== FlowSchemaList [flowcontrol.apiserver.k8s.io/v1beta1] +| `additionalItems` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool[``] +| +| `additionalProperties` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool[``] +| -Description:: -+ --- -FlowSchemaList is a list of FlowSchema objects. --- +| `allOf` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`array (undefined)`] +| -Type:: - `object` +| `anyOf` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`array (undefined)`] +| -Required:: - - `items` +| `default` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSON[`JSON`] +| default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. -[discrete] -=== Specification +| `definitions` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`object (undefined)`] +| -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `dependencies` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrStringArray[`object (undefined)`] +| -| `apiVersion` +| `description` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| -| `items` -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`array (FlowSchema flowcontrol.apiserver.k8s.io/v1beta1)`] -| `items` is a list of FlowSchemas. +| `enum` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSON[`array (JSON)`] +| -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `example` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSON[`JSON`] +| -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| `exclusiveMaximum` +| `boolean` +| -|=== +| `exclusiveMinimum` +| `boolean` +| -[id="gcepersistentdiskvolumesource-core-v1"] -== GCEPersistentDiskVolumeSource [core/v1] +| `externalDocs` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation[`ExternalDocumentation`] +| +| `format` +| `string` +| format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: -Description:: -+ --- -Represents a Persistent Disk resource in Google Compute Engine. +- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?\|5[1-5][0-9]{14}\|6(?:011\|5[0-9][0-9])[0-9]{12}\|3[47][0-9]{13}\|3(?:0[0-5]\|[68][0-9])[0-9]{11}\|(?:2131\|1800\|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}\|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. -A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. --- +| `id` +| `string` +| -Type:: - `object` +| `items` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrArray[``] +| -Required:: - - `pdName` +| `maxItems` +| `integer` +| -[discrete] -=== Specification +| `maxLength` +| `integer` +| -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `maxProperties` +| `integer` +| -| `fsType` -| `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +| `maximum` +| `number` +| -| `partition` +| `minItems` | `integer` -| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - -| `pdName` -| `string` -| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +| -| `readOnly` -| `boolean` -| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +| `minLength` +| `integer` +| -|=== +| `minProperties` +| `integer` +| -[id="gitrepovolumesource-core-v1"] -== GitRepoVolumeSource [core/v1] +| `minimum` +| `number` +| +| `multipleOf` +| `number` +| -Description:: -+ --- -Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. +| `not` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[``] +| -DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. --- +| `nullable` +| `boolean` +| -Type:: - `object` +| `oneOf` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`array (undefined)`] +| -Required:: - - `repository` +| `pattern` +| `string` +| -[discrete] -=== Specification +| `patternProperties` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`object (undefined)`] +| -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `properties` +| xref:../objects/index.adoc#io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[`object (undefined)`] +| -| `directory` -| `string` -| Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. +| `required` +| `array (string)` +| -| `repository` +| `title` | `string` -| Repository URL +| -| `revision` +| `type` | `string` -| Commit hash for the specified revision. - -|=== - -[id="glusterfspersistentvolumesource-core-v1"] -== GlusterfsPersistentVolumeSource [core/v1] - +| -Description:: -+ --- -Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. --- +| `uniqueItems` +| `boolean` +| -Type:: - `object` +| `x-kubernetes-embedded-resource` +| `boolean` +| x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). -Required:: - - `endpoints` - - `path` +| `x-kubernetes-int-or-string` +| `boolean` +| x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: + +1) anyOf: + - type: integer + - type: string +2) allOf: + - anyOf: + - type: integer + - type: string + - ... zero or more + +| `x-kubernetes-list-map-keys` +| `array (string)` +| x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. -[discrete] -=== Specification +This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +The properties specified must either be required or have a default value, to ensure those properties are present for all list items. -| `endpoints` +| `x-kubernetes-list-type` | `string` -| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +| x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: -| `endpointsNamespace` -| `string` -| EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +1) `atomic`: the list is treated as a single entity, like a scalar. + Atomic lists will be entirely replaced when updated. This extension + may be used on any type of list (struct, scalar, ...). +2) `set`: + Sets are lists that must not have multiple items with the same value. Each + value must be a scalar, an object with x-kubernetes-map-type `atomic` or an + array with x-kubernetes-list-type `atomic`. +3) `map`: + These lists are like maps in that their elements have a non-index key + used to identify them. Order is preserved upon merge. The map tag + must only be used on a list with elements of type object. +Defaults to atomic for arrays. -| `path` +| `x-kubernetes-map-type` | `string` -| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +| x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: -| `readOnly` +1) `granular`: + These maps are actual maps (key-value pairs) and each fields are independent + from each other (they can each be manipulated by separate actors). This is + the default behaviour for all maps. +2) `atomic`: the list is treated as a single entity, like a scalar. + Atomic maps will be entirely replaced when updated. + +| `x-kubernetes-preserve-unknown-fields` | `boolean` -| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +| x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. |=== -[id="glusterfsvolumesource-core-v1"] -== GlusterfsVolumeSource [core/v1] +[id="io.k8s.apimachinery.pkg.api.resource.Quantity"] +== io.k8s.apimachinery.pkg.api.resource.Quantity schema Description:: + -- -Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. --- - -Type:: - `object` - -Required:: - - `endpoints` - - `path` +Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. -[discrete] -=== Specification +The serialization format is: -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description + ::= + (Note that may be empty, from the "" case in .) + ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei + (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) + ::= m | "" | k | M | G | T | P | E + (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) + ::= "e" | "E" -| `endpoints` -| `string` -| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. -| `path` -| `string` -| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. -| `readOnly` -| `boolean` -| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: + a. No precision is lost + b. No fractional digits will be emitted + c. The exponent (or suffix) is as large as possible. +The sign will be omitted unless the number is negative. -|=== +Examples: + 1.5 will be serialized as "1500m" + 1.5Gi will be serialized as "1536Mi" -[id="grouplist-user-openshift-io-v1"] -== GroupList [user.openshift.io/v1] +Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. +Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) -Description:: -+ --- -GroupList is a collection of Groups +This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. -- Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`array (Group user.openshift.io/v1)`] -| Items is the list of groups - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + `string` -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| -|=== -[id="groupversionkind-meta-v1"] -== GroupVersionKind [meta/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.Condition"] +== io.k8s.apimachinery.pkg.apis.meta.v1.Condition schema Description:: + -- -GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling +Condition contains details for one aspect of the current state of this API Resource. -- Type:: `object` Required:: - - `group` - - `version` - - `kind` + - `type` + - `status` + - `lastTransitionTime` + - `reason` + - `message` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `group` -| `string` -| - -| `kind` -| `string` -| +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. -| `version` +| `message` | `string` -| - -|=== - -[id="handler-core-v1"] -== Handler [core/v1] - - -Description:: -+ --- -Handler defines a specific action that should be taken --- - -Type:: - `object` - - -[discrete] -=== Specification +| message is a human readable message indicating details about the transition. This may be an empty string. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `observedGeneration` +| `integer` +| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. -| `exec` -| xref:../objects/index.adoc#execaction-core-v1[`ExecAction core/v1`] -| One and only one of the following should be specified. Exec specifies the action to take. +| `reason` +| `string` +| reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. -| `httpGet` -| xref:../objects/index.adoc#httpgetaction-core-v1[`HTTPGetAction core/v1`] -| HTTPGet specifies the http request to perform. +| `status` +| `string` +| status of the condition, one of True, False, Unknown. -| `tcpSocket` -| xref:../objects/index.adoc#tcpsocketaction-core-v1[`TCPSocketAction core/v1`] -| TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported +| `type` +| `string` +| type of condition in CamelCase or in foo.example.com/CamelCase. |=== -[id="helmchartrepositorylist-helm-openshift-io-v1beta1"] -== HelmChartRepositoryList [helm.openshift.io/v1beta1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions"] +== io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions schema Description:: + -- -HelmChartRepositoryList is a list of HelmChartRepository +DeleteOptions may be provided when deleting an API object. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -5479,38 +5371,48 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`array (HelmChartRepository helm.openshift.io/v1beta1)`] -| List of helmchartrepositories. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `dryRun` +| `array (string)` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed + +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. + +| `preconditions` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions[`Preconditions`] +| Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. + +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |=== -[id="horizontalpodautoscalerlist-autoscaling-v1"] -== HorizontalPodAutoscalerList [autoscaling/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2"] +== io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2 schema Description:: + -- -list of horizontal pod autoscaler objects. +DeleteOptions may be provided when deleting an API object. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -5520,5641 +5422,395 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc#horizontalpodautoscaler-autoscaling-v1[`array (HorizontalPodAutoscaler autoscaling/v1)`] -| list of horizontal pod autoscaler objects. +| `dryRun` +| `array (string)` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed + +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. - -|=== - -[id="hostalias-core-v1"] -== HostAlias [core/v1] - - -Description:: -+ --- -HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. -| `hostnames` -| `array (string)` -| Hostnames for the above IP address. +| `preconditions` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions[`Preconditions`] +| Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. -| `ip` +| `propagationPolicy` | `string` -| IP address of the host file entry. +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |=== -[id="hostpathvolumesource-core-v1"] -== HostPathVolumeSource [core/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionKind"] +== io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionKind schema Description:: + -- -Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. +GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling -- Type:: `object` Required:: - - `path` + - `group` + - `version` + - `kind` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `path` +| `group` | `string` -| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +| -| `type` +| `kind` +| `string` +| + +| `version` | `string` -| Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +| |=== -[id="hostsubnetlist-network-openshift-io-v1"] -== HostSubnetList [network.openshift.io/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"] +== io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector schema Description:: + -- -HostSubnetList is a list of HostSubnet +A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`array (HostSubnet network.openshift.io/v1)`] -| List of hostsubnets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `matchExpressions` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement[`array (LabelSelectorRequirement)`] +| matchExpressions is a list of label selector requirements. The requirements are ANDed. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `matchLabels` +| `object (string)` +| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -[id="httpgetaction-core-v1"] -== HTTPGetAction [core/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"] +== io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta schema Description:: + -- -HTTPGetAction describes an action based on HTTP Get requests. +ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. -- Type:: `object` -Required:: - - `port` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `host` +| `continue` | `string` -| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +| continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. -| `httpHeaders` -| xref:../objects/index.adoc#httpheader-core-v1[`array (HTTPHeader core/v1)`] -| Custom headers to set in the request. HTTP allows repeated headers. +| `remainingItemCount` +| `integer` +| remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. -| `path` +| `resourceVersion` | `string` -| Path to access on the HTTP server. - -| `port` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] -| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +| String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency -| `scheme` +| `selfLink` | `string` -| Scheme to use for connecting to the host. Defaults to HTTP. +| selfLink is a URL representing this object. Populated by the system. Read-only. + +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. |=== -[id="httpheader-core-v1"] -== HTTPHeader [core/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime"] +== io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime schema Description:: + -- -HTTPHeader describes a custom header to be used in HTTP probes +MicroTime is version of Time with microsecond level precision. -- Type:: - `object` - -Required:: - - `name` - - `value` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `name` -| `string` -| The header field name + `string` -| `value` -| `string` -| The header field value -|=== -[id="identitylist-user-openshift-io-v1"] -== IdentityList [user.openshift.io/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"] +== io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta schema Description:: + -- -IdentityList is a collection of Identities +ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`array (Identity user.openshift.io/v1)`] -| Items is the list of identities +| `annotations` +| `object (string)` +| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations -| `kind` +| `clusterName` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="imagecontentsourcepolicylist-operator-openshift-io-v1alpha1"] -== ImageContentSourcePolicyList [operator.openshift.io/v1alpha1] - - -Description:: -+ --- -ImageContentSourcePolicyList is a list of ImageContentSourcePolicy --- +| The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. -Type:: - `object` +| `creationTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. -Required:: - - `items` +Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -[discrete] -=== Specification +| `deletionGracePeriodSeconds` +| `integer` +| Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `deletionTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -| `items` -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`array (ImageContentSourcePolicy operator.openshift.io/v1alpha1)`] -| List of imagecontentsourcepolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `finalizers` +| `array (string)` +| Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. -| `kind` +| `generateName` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="imagelist-config-openshift-io-v1"] -== ImageList [config.openshift.io/v1] - +| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. -Description:: -+ --- -ImageList is a list of Image --- +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). -Type:: - `object` +Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency -Required:: - - `items` +| `generation` +| `integer` +| A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. -[discrete] -=== Specification +| `labels` +| `object (string)` +| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `managedFields` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry[`array (ManagedFieldsEntry)`] +| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. -| `apiVersion` +| `name` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`array (Image config.openshift.io/v1)`] -| List of images. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names -| `kind` +| `namespace` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="imagelist-image-openshift-io-v1"] -== ImageList [image.openshift.io/v1] - - -Description:: -+ --- -ImageList is a list of Image objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces -| `items` -| xref:../image_apis/image-image-openshift-io-v1.adoc#image-image-openshift-io-v1[`array (Image image.openshift.io/v1)`] -| Items is a list of images +| `ownerReferences` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference[`array (OwnerReference)`] +| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. -| `kind` +| `resourceVersion` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="imageprunerlist-imageregistry-operator-openshift-io-v1"] -== ImagePrunerList [imageregistry.operator.openshift.io/v1] - - -Description:: -+ --- -ImagePrunerList is a list of ImagePruner --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification +| An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency -| `apiVersion` +| `selfLink` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| SelfLink is a URL representing this object. Populated by the system. Read-only. -| `items` -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`array (ImagePruner imageregistry.operator.openshift.io/v1)`] -| List of imagepruners. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -| `kind` +| `uid` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |=== -[id="imagestreamlayers-image-openshift-io-v1"] -== ImageStreamLayers [image.openshift.io/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2"] +== io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2 schema Description:: + -- -ImageStreamLayers describes information about the layers referenced by images in this image stream. +ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. -- Type:: `object` -Required:: - - `blobs` - - `images` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `blobs` -| xref:../objects/index.adoc#imagelayerdata-image-openshift-io-v1[`object (ImageLayerData image.openshift.io/v1)`] -| blobs is a map of blob name to metadata about the blob. - -| `images` -| xref:../objects/index.adoc#imageblobreferences-image-openshift-io-v1[`object (ImageBlobReferences image.openshift.io/v1)`] -| images is a map between an image name and the names of the blobs and config that comprise the image. +| `annotations` +| `object (string)` +| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations -| `kind` +| `clusterName` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| - -|=== - -[id="imagestreamlist-image-openshift-io-v1"] -== ImageStreamList [image.openshift.io/v1] - - -Description:: -+ --- -ImageStreamList is a list of ImageStream objects. --- +| The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. -Type:: - `object` +| `creationTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. -Required:: - - `items` +Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -[discrete] -=== Specification +| `deletionGracePeriodSeconds` +| `integer` +| Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `deletionTimestamp` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -| `items` -| xref:../image_apis/imagestream-image-openshift-io-v1.adoc#imagestream-image-openshift-io-v1[`array (ImageStream image.openshift.io/v1)`] -| Items is a list of imageStreams +| `finalizers` +| `array (string)` +| Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. -| `kind` +| `generateName` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="imagestreamtaglist-image-openshift-io-v1"] -== ImageStreamTagList [image.openshift.io/v1] - - -Description:: -+ --- -ImageStreamTagList is a list of ImageStreamTag objects. --- - -Type:: - `object` +| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. -Required:: - - `items` +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). -[discrete] -=== Specification +Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `generation` +| `integer` +| A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `labels` +| `object (string)` +| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels -| `items` -| xref:../image_apis/imagestreamtag-image-openshift-io-v1.adoc#imagestreamtag-image-openshift-io-v1[`array (ImageStreamTag image.openshift.io/v1)`] -| Items is the list of image stream tags +| `managedFields` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry[`array (ManagedFieldsEntry)`] +| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. -| `kind` +| `name` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="imagetaglist-image-openshift-io-v1"] -== ImageTagList [image.openshift.io/v1] - - -Description:: -+ --- -ImageTagList is a list of ImageTag objects. When listing image tags, the image field is not populated. Tags are returned in alphabetical order by image stream and then tag. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../image_apis/imagetag-image-openshift-io-v1.adoc#imagetag-image-openshift-io-v1[`array (ImageTag image.openshift.io/v1)`] -| Items is the list of image stream tags - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="infrastructurelist-config-openshift-io-v1"] -== InfrastructureList [config.openshift.io/v1] - - -Description:: -+ --- -InfrastructureList is a list of Infrastructure --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`array (Infrastructure config.openshift.io/v1)`] -| List of infrastructures. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="ingressclasslist-networking-k8s-io-v1"] -== IngressClassList [networking.k8s.io/v1] - - -Description:: -+ --- -IngressClassList is a collection of IngressClasses. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/ingressclass-networking-k8s-io-v1.adoc#ingressclass-networking-k8s-io-v1[`array (IngressClass networking.k8s.io/v1)`] -| Items is the list of IngressClasses. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. - -|=== - -[id="ingresscontrollerlist-operator-openshift-io-v1"] -== IngressControllerList [operator.openshift.io/v1] - - -Description:: -+ --- -IngressControllerList is a list of IngressController --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`array (IngressController operator.openshift.io/v1)`] -| List of ingresscontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="ingresslist-config-openshift-io-v1"] -== IngressList [config.openshift.io/v1] - - -Description:: -+ --- -IngressList is a list of Ingress --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`array (Ingress config.openshift.io/v1)`] -| List of ingresses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="ingresslist-networking-k8s-io-v1"] -== IngressList [networking.k8s.io/v1] - - -Description:: -+ --- -IngressList is a collection of Ingress. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/ingress-networking-k8s-io-v1.adoc#ingress-networking-k8s-io-v1[`array (Ingress networking.k8s.io/v1)`] -| Items is the list of Ingress. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="installplanlist-operators-coreos-com-v1alpha1"] -== InstallPlanList [operators.coreos.com/v1alpha1] - - -Description:: -+ --- -InstallPlanList is a list of InstallPlan --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`array (InstallPlan operators.coreos.com/v1alpha1)`] -| List of installplans. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="intorstring-util-none"] -== IntOrString [util/none] - - -Description:: -+ --- -IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. --- - -Type:: - `string` - - - -[id="ippoollist-whereabouts-cni-cncf-io-v1alpha1"] -== IPPoolList [whereabouts.cni.cncf.io/v1alpha1] - - -Description:: -+ --- -IPPoolList is a list of IPPool --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc#ippool-whereabouts-cni-cncf-io-v1alpha1[`array (IPPool whereabouts.cni.cncf.io/v1alpha1)`] -| List of ippools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="iscsipersistentvolumesource-core-v1"] -== ISCSIPersistentVolumeSource [core/v1] - - -Description:: -+ --- -ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. --- - -Type:: - `object` - -Required:: - - `targetPortal` - - `iqn` - - `lun` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `chapAuthDiscovery` -| `boolean` -| whether support iSCSI Discovery CHAP authentication - -| `chapAuthSession` -| `boolean` -| whether support iSCSI Session CHAP authentication - -| `fsType` -| `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - -| `initiatorName` -| `string` -| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. - -| `iqn` -| `string` -| Target iSCSI Qualified Name. - -| `iscsiInterface` -| `string` -| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). - -| `lun` -| `integer` -| iSCSI Target Lun number. - -| `portals` -| `array (string)` -| iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - -| `readOnly` -| `boolean` -| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. - -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| CHAP Secret for iSCSI target and initiator authentication - -| `targetPortal` -| `string` -| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - -|=== - -[id="iscsivolumesource-core-v1"] -== ISCSIVolumeSource [core/v1] - - -Description:: -+ --- -Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. --- - -Type:: - `object` - -Required:: - - `targetPortal` - - `iqn` - - `lun` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `chapAuthDiscovery` -| `boolean` -| whether support iSCSI Discovery CHAP authentication - -| `chapAuthSession` -| `boolean` -| whether support iSCSI Session CHAP authentication - -| `fsType` -| `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - -| `initiatorName` -| `string` -| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. - -| `iqn` -| `string` -| Target iSCSI Qualified Name. - -| `iscsiInterface` -| `string` -| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). - -| `lun` -| `integer` -| iSCSI Target Lun number. - -| `portals` -| `array (string)` -| iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - -| `readOnly` -| `boolean` -| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. - -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| CHAP Secret for iSCSI target and initiator authentication - -| `targetPortal` -| `string` -| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). - -|=== - -[id="joblist-batch-v1"] -== JobList [batch/v1] - - -Description:: -+ --- -JobList is a collection of jobs. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`array (Job batch/v1)`] -| items is the list of Jobs. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="keytopath-core-v1"] -== KeyToPath [core/v1] - - -Description:: -+ --- -Maps a string key to a path within a volume. --- - -Type:: - `object` - -Required:: - - `key` - - `path` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `key` -| `string` -| The key to project. - -| `mode` -| `integer` -| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - -| `path` -| `string` -| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. - -|=== - -[id="kubeapiserverlist-operator-openshift-io-v1"] -== KubeAPIServerList [operator.openshift.io/v1] - - -Description:: -+ --- -KubeAPIServerList is a list of KubeAPIServer --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`array (KubeAPIServer operator.openshift.io/v1)`] -| List of kubeapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="kubecontrollermanagerlist-operator-openshift-io-v1"] -== KubeControllerManagerList [operator.openshift.io/v1] - - -Description:: -+ --- -KubeControllerManagerList is a list of KubeControllerManager --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`array (KubeControllerManager operator.openshift.io/v1)`] -| List of kubecontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="kubeletconfiglist-machineconfiguration-openshift-io-v1"] -== KubeletConfigList [machineconfiguration.openshift.io/v1] - - -Description:: -+ --- -KubeletConfigList is a list of KubeletConfig --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`array (KubeletConfig machineconfiguration.openshift.io/v1)`] -| List of kubeletconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="kubeschedulerlist-operator-openshift-io-v1"] -== KubeSchedulerList [operator.openshift.io/v1] - - -Description:: -+ --- -KubeSchedulerList is a list of KubeScheduler --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`array (KubeScheduler operator.openshift.io/v1)`] -| List of kubeschedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="kubestorageversionmigratorlist-operator-openshift-io-v1"] -== KubeStorageVersionMigratorList [operator.openshift.io/v1] - - -Description:: -+ --- -KubeStorageVersionMigratorList is a list of KubeStorageVersionMigrator --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`array (KubeStorageVersionMigrator operator.openshift.io/v1)`] -| List of kubestorageversionmigrators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="labelselector-meta-v1"] -== LabelSelector [meta/v1] - - -Description:: -+ --- -A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `matchExpressions` -| xref:../objects/index.adoc#labelselectorrequirement-meta-v1[`array (LabelSelectorRequirement meta/v1)`] -| matchExpressions is a list of label selector requirements. The requirements are ANDed. - -| `matchLabels` -| `object (string)` -| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. - -|=== - -[id="labelselectorrequirement-meta-v1"] -== LabelSelectorRequirement [meta/v1] - - -Description:: -+ --- -A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. --- - -Type:: - `object` - -Required:: - - `key` - - `operator` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `key` -| `string` -| key is the label key that the selector applies to. - -| `operator` -| `string` -| operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. - -| `values` -| `array (string)` -| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - -|=== - -[id="leaselist-coordination-k8s-io-v1"] -== LeaseList [coordination.k8s.io/v1] - - -Description:: -+ --- -LeaseList is a list of Lease objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../metadata_apis/lease-coordination-k8s-io-v1.adoc#lease-coordination-k8s-io-v1[`array (Lease coordination.k8s.io/v1)`] -| Items is a list of schema objects. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="lifecycle-core-v1"] -== Lifecycle [core/v1] - - -Description:: -+ --- -Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `postStart` -| xref:../objects/index.adoc#handler-core-v1[`Handler core/v1`] -| PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - -| `preStop` -| xref:../objects/index.adoc#handler-core-v1[`Handler core/v1`] -| PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - -|=== - -[id="limitrangeitem-core-v1"] -== LimitRangeItem [core/v1] - - -Description:: -+ --- -LimitRangeItem defines a min/max usage limit for any resource that matches on kind. --- - -Type:: - `object` - -Required:: - - `type` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `default` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Default resource requirement limit value by resource name if resource limit is omitted. - -| `defaultRequest` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. - -| `max` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Max usage constraints on this kind by resource name. - -| `maxLimitRequestRatio` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. - -| `min` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Min usage constraints on this kind by resource name. - -| `type` -| `string` -| Type of resource that this limit applies to. - -|=== - -[id="limitrangelist-core-v1"] -== LimitRangeList [core/v1] - - -Description:: -+ --- -LimitRangeList is a list of LimitRange items. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../schedule_and_quota_apis/limitrange-core-v1.adoc#limitrange-core-v1[`array (LimitRange core/v1)`] -| Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="listmeta-meta-v1"] -== ListMeta [meta/v1] - - -Description:: -+ --- -ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `continue` -| `string` -| continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. - -| `remainingItemCount` -| `integer` -| remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. - -| `resourceVersion` -| `string` -| String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - -| `selfLink` -| `string` -| selfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. - -|=== - -[id="loadbalanceringress-core-v1"] -== LoadBalancerIngress [core/v1] - - -Description:: -+ --- -LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `hostname` -| `string` -| Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) - -| `ip` -| `string` -| IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) - -| `ports` -| xref:../objects/index.adoc#portstatus-core-v1[`array (PortStatus core/v1)`] -| Ports is a list of records of service ports If used, every port defined in the service should have an entry in it - -|=== - -[id="loadbalancerstatus-core-v1"] -== LoadBalancerStatus [core/v1] - - -Description:: -+ --- -LoadBalancerStatus represents the status of a load-balancer. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `ingress` -| xref:../objects/index.adoc#loadbalanceringress-core-v1[`array (LoadBalancerIngress core/v1)`] -| Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. - -|=== - -[id="localobjectreference-core-v1"] -== LocalObjectReference [core/v1] - - -Description:: -+ --- -LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `name` -| `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - -|=== - -[id="localobjectreference_v2-core-v1"] -== LocalObjectReference_v2 [core/v1] - - -Description:: -+ --- -LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `name` -| `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - -|=== - -[id="localvolumesource-core-v1"] -== LocalVolumeSource [core/v1] - - -Description:: -+ --- -Local represents directly-attached storage with node affinity (Beta feature) --- - -Type:: - `object` - -Required:: - - `path` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `fsType` -| `string` -| Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. - -| `path` -| `string` -| The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). - -|=== - -[id="machineautoscalerlist-autoscaling-openshift-io-v1beta1"] -== MachineAutoscalerList [autoscaling.openshift.io/v1beta1] - - -Description:: -+ --- -MachineAutoscalerList is a list of MachineAutoscaler --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`array (MachineAutoscaler autoscaling.openshift.io/v1beta1)`] -| List of machineautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="machineconfiglist-machineconfiguration-openshift-io-v1"] -== MachineConfigList [machineconfiguration.openshift.io/v1] - - -Description:: -+ --- -MachineConfigList is a list of MachineConfig --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`array (MachineConfig machineconfiguration.openshift.io/v1)`] -| List of machineconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="machineconfigpoollist-machineconfiguration-openshift-io-v1"] -== MachineConfigPoolList [machineconfiguration.openshift.io/v1] - - -Description:: -+ --- -MachineConfigPoolList is a list of MachineConfigPool --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`array (MachineConfigPool machineconfiguration.openshift.io/v1)`] -| List of machineconfigpools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="machinehealthchecklist-machine-openshift-io-v1beta1"] -== MachineHealthCheckList [machine.openshift.io/v1beta1] - - -Description:: -+ --- -MachineHealthCheckList is a list of MachineHealthCheck --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`array (MachineHealthCheck machine.openshift.io/v1beta1)`] -| List of machinehealthchecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="machinelist-machine-openshift-io-v1beta1"] -== MachineList [machine.openshift.io/v1beta1] - - -Description:: -+ --- -MachineList is a list of Machine --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`array (Machine machine.openshift.io/v1beta1)`] -| List of machines. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="machinesetlist-machine-openshift-io-v1beta1"] -== MachineSetList [machine.openshift.io/v1beta1] - - -Description:: -+ --- -MachineSetList is a list of MachineSet --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`array (MachineSet machine.openshift.io/v1beta1)`] -| List of machinesets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="managedfieldsentry-meta-v1"] -== ManagedFieldsEntry [meta/v1] - - -Description:: -+ --- -ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - -| `fieldsType` -| `string` -| FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - -| `fieldsV1` -| xref:../objects/index.adoc#fieldsv1-meta-v1[`FieldsV1 meta/v1`] -| FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. - -| `manager` -| `string` -| Manager is an identifier of the workflow managing these fields. - -| `operation` -| `string` -| Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - -| `subresource` -| `string` -| Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - -| `time` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' - -|=== - -[id="microtime-meta-v1"] -== MicroTime [meta/v1] - - -Description:: -+ --- -MicroTime is version of Time with microsecond level precision. --- - -Type:: - `string` - - - -[id="mutatingwebhookconfigurationlist-admissionregistration-k8s-io-v1"] -== MutatingWebhookConfigurationList [admissionregistration.k8s.io/v1] - - -Description:: -+ --- -MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#mutatingwebhookconfiguration-admissionregistration-k8s-io-v1[`array (MutatingWebhookConfiguration admissionregistration.k8s.io/v1)`] -| List of MutatingWebhookConfiguration. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="namespacecondition-core-v1"] -== NamespaceCondition [core/v1] - - -Description:: -+ --- -NamespaceCondition contains details about state of namespace. --- - -Type:: - `object` - -Required:: - - `type` - - `status` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| - -| `message` -| `string` -| - -| `reason` -| `string` -| - -| `status` -| `string` -| Status of the condition, one of True, False, Unknown. - -| `type` -| `string` -| Type of namespace controller condition. - -|=== - -[id="namespacelist-core-v1"] -== NamespaceList [core/v1] - - -Description:: -+ --- -NamespaceList is a list of Namespaces. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../metadata_apis/namespace-core-v1.adoc#namespace-core-v1[`array (Namespace core/v1)`] -| Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="netnamespacelist-network-openshift-io-v1"] -== NetNamespaceList [network.openshift.io/v1] - - -Description:: -+ --- -NetNamespaceList is a list of NetNamespace --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`array (NetNamespace network.openshift.io/v1)`] -| List of netnamespaces. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="networkattachmentdefinitionlist-k8s-cni-cncf-io-v1"] -== NetworkAttachmentDefinitionList [k8s.cni.cncf.io/v1] - - -Description:: -+ --- -NetworkAttachmentDefinitionList is a list of NetworkAttachmentDefinition --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc#networkattachmentdefinition-k8s-cni-cncf-io-v1[`array (NetworkAttachmentDefinition k8s.cni.cncf.io/v1)`] -| List of network-attachment-definitions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="networklist-config-openshift-io-v1"] -== NetworkList [config.openshift.io/v1] - - -Description:: -+ --- -NetworkList is a list of Network --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`array (Network config.openshift.io/v1)`] -| List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="networklist-operator-openshift-io-v1"] -== NetworkList [operator.openshift.io/v1] - - -Description:: -+ --- -NetworkList is a list of Network --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`array (Network operator.openshift.io/v1)`] -| List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="networkpolicylist-networking-k8s-io-v1"] -== NetworkPolicyList [networking.k8s.io/v1] - - -Description:: -+ --- -NetworkPolicyList is a list of NetworkPolicy objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/networkpolicy-networking-k8s-io-v1.adoc#networkpolicy-networking-k8s-io-v1[`array (NetworkPolicy networking.k8s.io/v1)`] -| Items is a list of schema objects. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="nfsvolumesource-core-v1"] -== NFSVolumeSource [core/v1] - - -Description:: -+ --- -Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. --- - -Type:: - `object` - -Required:: - - `server` - - `path` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `path` -| `string` -| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - -| `readOnly` -| `boolean` -| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - -| `server` -| `string` -| Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - -|=== - -[id="nodeaddress-core-v1"] -== NodeAddress [core/v1] - - -Description:: -+ --- -NodeAddress contains information for the node's address. --- - -Type:: - `object` - -Required:: - - `type` - - `address` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `address` -| `string` -| The node address. - -| `type` -| `string` -| Node address type, one of Hostname, ExternalIP or InternalIP. - -|=== - -[id="nodeaffinity-core-v1"] -== NodeAffinity [core/v1] - - -Description:: -+ --- -Node affinity is a group of node affinity scheduling rules. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `preferredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#preferredschedulingterm-core-v1[`array (PreferredSchedulingTerm core/v1)`] -| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. - -| `requiredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#nodeselector-core-v1[`NodeSelector core/v1`] -| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. - -|=== - -[id="nodecondition-core-v1"] -== NodeCondition [core/v1] - - -Description:: -+ --- -NodeCondition contains condition information for a node. --- - -Type:: - `object` - -Required:: - - `type` - - `status` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `lastHeartbeatTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time we got an update on a given condition. - -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time the condition transit from one status to another. - -| `message` -| `string` -| Human readable message indicating details about last transition. - -| `reason` -| `string` -| (brief) reason for the condition's last transition. - -| `status` -| `string` -| Status of the condition, one of True, False, Unknown. - -| `type` -| `string` -| Type of node condition. - -|=== - -[id="nodeconfigsource-core-v1"] -== NodeConfigSource [core/v1] - - -Description:: -+ --- -NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `configMap` -| xref:../objects/index.adoc#configmapnodeconfigsource-core-v1[`ConfigMapNodeConfigSource core/v1`] -| ConfigMap is a reference to a Node's ConfigMap - -|=== - -[id="nodedaemonendpoints-core-v1"] -== NodeDaemonEndpoints [core/v1] - - -Description:: -+ --- -NodeDaemonEndpoints lists ports opened by daemons running on the Node. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `kubeletEndpoint` -| xref:../objects/index.adoc#daemonendpoint-core-v1[`DaemonEndpoint core/v1`] -| Endpoint on which Kubelet is listening. - -|=== - -[id="nodelist-core-v1"] -== NodeList [core/v1] - - -Description:: -+ --- -NodeList is the whole list of all Nodes which have been registered with master. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../node_apis/node-core-v1.adoc#node-core-v1[`array (Node core/v1)`] -| List of nodes - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="nodeselector-core-v1"] -== NodeSelector [core/v1] - - -Description:: -+ --- -A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. --- - -Type:: - `object` - -Required:: - - `nodeSelectorTerms` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `nodeSelectorTerms` -| xref:../objects/index.adoc#nodeselectorterm-core-v1[`array (NodeSelectorTerm core/v1)`] -| Required. A list of node selector terms. The terms are ORed. - -|=== - -[id="nodeselectorrequirement-core-v1"] -== NodeSelectorRequirement [core/v1] - - -Description:: -+ --- -A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. --- - -Type:: - `object` - -Required:: - - `key` - - `operator` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `key` -| `string` -| The label key that the selector applies to. - -| `operator` -| `string` -| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. - -| `values` -| `array (string)` -| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. - -|=== - -[id="nodeselectorterm-core-v1"] -== NodeSelectorTerm [core/v1] - - -Description:: -+ --- -A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `matchExpressions` -| xref:../objects/index.adoc#nodeselectorrequirement-core-v1[`array (NodeSelectorRequirement core/v1)`] -| A list of node selector requirements by node's labels. - -| `matchFields` -| xref:../objects/index.adoc#nodeselectorrequirement-core-v1[`array (NodeSelectorRequirement core/v1)`] -| A list of node selector requirements by node's fields. - -|=== - -[id="nodesysteminfo-core-v1"] -== NodeSystemInfo [core/v1] - - -Description:: -+ --- -NodeSystemInfo is a set of ids/uuids to uniquely identify the node. --- - -Type:: - `object` - -Required:: - - `machineID` - - `systemUUID` - - `bootID` - - `kernelVersion` - - `osImage` - - `containerRuntimeVersion` - - `kubeletVersion` - - `kubeProxyVersion` - - `operatingSystem` - - `architecture` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `architecture` -| `string` -| The Architecture reported by the node - -| `bootID` -| `string` -| Boot ID reported by the node. - -| `containerRuntimeVersion` -| `string` -| ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). - -| `kernelVersion` -| `string` -| Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). - -| `kubeProxyVersion` -| `string` -| KubeProxy Version reported by the node. - -| `kubeletVersion` -| `string` -| Kubelet Version reported by the node. - -| `machineID` -| `string` -| MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html - -| `operatingSystem` -| `string` -| The Operating System reported by the node - -| `osImage` -| `string` -| OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). - -| `systemUUID` -| `string` -| SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid - -|=== - -[id="oauthaccesstokenlist-oauth-openshift-io-v1"] -== OAuthAccessTokenList [oauth.openshift.io/v1] - - -Description:: -+ --- -OAuthAccessTokenList is a collection of OAuth access tokens --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc#oauthaccesstoken-oauth-openshift-io-v1[`array (OAuthAccessToken oauth.openshift.io/v1)`] -| Items is the list of OAuth access tokens - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="oauthauthorizetokenlist-oauth-openshift-io-v1"] -== OAuthAuthorizeTokenList [oauth.openshift.io/v1] - - -Description:: -+ --- -OAuthAuthorizeTokenList is a collection of OAuth authorization tokens --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc#oauthauthorizetoken-oauth-openshift-io-v1[`array (OAuthAuthorizeToken oauth.openshift.io/v1)`] -| Items is the list of OAuth authorization tokens - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="oauthclientauthorizationlist-oauth-openshift-io-v1"] -== OAuthClientAuthorizationList [oauth.openshift.io/v1] - - -Description:: -+ --- -OAuthClientAuthorizationList is a collection of OAuth client authorizations --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc#oauthclientauthorization-oauth-openshift-io-v1[`array (OAuthClientAuthorization oauth.openshift.io/v1)`] -| Items is the list of OAuth client authorizations - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="oauthclientlist-oauth-openshift-io-v1"] -== OAuthClientList [oauth.openshift.io/v1] - - -Description:: -+ --- -OAuthClientList is a collection of OAuth clients --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../oauth_apis/oauthclient-oauth-openshift-io-v1.adoc#oauthclient-oauth-openshift-io-v1[`array (OAuthClient oauth.openshift.io/v1)`] -| Items is the list of OAuth clients - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="oauthlist-config-openshift-io-v1"] -== OAuthList [config.openshift.io/v1] - - -Description:: -+ --- -OAuthList is a list of OAuth --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`array (OAuth config.openshift.io/v1)`] -| List of oauths. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="objectfieldselector-core-v1"] -== ObjectFieldSelector [core/v1] - - -Description:: -+ --- -ObjectFieldSelector selects an APIVersioned field of an object. --- - -Type:: - `object` - -Required:: - - `fieldPath` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| Version of the schema the FieldPath is written in terms of, defaults to "v1". - -| `fieldPath` -| `string` -| Path of the field to select in the specified API version. - -|=== - -[id="objectmeta-meta-v1"] -== ObjectMeta [meta/v1] - - -Description:: -+ --- -ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `annotations` -| `object (string)` -| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations - -| `clusterName` -| `string` -| The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. - -| `creationTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. - -Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `deletionGracePeriodSeconds` -| `integer` -| Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - -| `deletionTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. - -Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `finalizers` -| `array (string)` -| Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - -| `generateName` -| `string` -| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. - -If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). - -Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - -| `generation` -| `integer` -| A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - -| `labels` -| `object (string)` -| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels - -| `managedFields` -| xref:../objects/index.adoc#managedfieldsentry-meta-v1[`array (ManagedFieldsEntry meta/v1)`] -| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - -| `name` -| `string` -| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names - -| `namespace` -| `string` -| Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. - -Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces - -| `ownerReferences` -| xref:../objects/index.adoc#ownerreference-meta-v1[`array (OwnerReference meta/v1)`] -| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - -| `resourceVersion` -| `string` -| An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. - -Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - -| `selfLink` -| `string` -| SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. - -| `uid` -| `string` -| UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. - -Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - -|=== - -[id="objectmeta_v2-meta-v1"] -== ObjectMeta_v2 [meta/v1] - - -Description:: -+ --- -ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `annotations` -| `object (string)` -| Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations - -| `clusterName` -| `string` -| The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. - -| `creationTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. - -Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `deletionGracePeriodSeconds` -| `integer` -| Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - -| `deletionTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. - -Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `finalizers` -| `array (string)` -| Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - -| `generateName` -| `string` -| GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. - -If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). - -Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - -| `generation` -| `integer` -| A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - -| `labels` -| `object (string)` -| Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels - -| `managedFields` -| xref:../objects/index.adoc#managedfieldsentry-meta-v1[`array (ManagedFieldsEntry meta/v1)`] -| ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - -| `name` -| `string` -| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names - -| `namespace` -| `string` -| Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. - -Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces - -| `ownerReferences` -| xref:../objects/index.adoc#ownerreference_v2-meta-v1[`array (OwnerReference_v2 meta/v1)`] -| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - -| `resourceVersion` -| `string` -| An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. - -Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - -| `selfLink` -| `string` -| SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. - -| `uid` -| `string` -| UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. - -Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - -|=== - -[id="objectreference-core-v1"] -== ObjectReference [core/v1] - - -Description:: -+ --- -ObjectReference contains enough information to let you inspect or modify the referred object. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| API version of the referent. - -| `fieldPath` -| `string` -| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. - -| `kind` -| `string` -| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `name` -| `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - -| `namespace` -| `string` -| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - -| `resourceVersion` -| `string` -| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - -| `uid` -| `string` -| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids - -|=== - -[id="objectreference_v2-core-v1"] -== ObjectReference_v2 [core/v1] - - -Description:: -+ --- -ObjectReference contains enough information to let you inspect or modify the referred object. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| API version of the referent. - -| `fieldPath` -| `string` -| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. - -| `kind` -| `string` -| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `name` -| `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - -| `namespace` -| `string` -| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - -| `resourceVersion` -| `string` -| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - -| `uid` -| `string` -| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids - -|=== - -[id="openshiftapiserverlist-operator-openshift-io-v1"] -== OpenShiftAPIServerList [operator.openshift.io/v1] - - -Description:: -+ --- -OpenShiftAPIServerList is a list of OpenShiftAPIServer --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`array (OpenShiftAPIServer operator.openshift.io/v1)`] -| List of openshiftapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="openshiftcontrollermanagerlist-operator-openshift-io-v1"] -== OpenShiftControllerManagerList [operator.openshift.io/v1] - - -Description:: -+ --- -OpenShiftControllerManagerList is a list of OpenShiftControllerManager --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`array (OpenShiftControllerManager operator.openshift.io/v1)`] -| List of openshiftcontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="operatorconditionlist-operators-coreos-com-v2"] -== OperatorConditionList [operators.coreos.com/v2] - - -Description:: -+ --- -OperatorConditionList is a list of OperatorCondition --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`array (OperatorCondition operators.coreos.com/v2)`] -| List of operatorconditions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="operatorgrouplist-operators-coreos-com-v1"] -== OperatorGroupList [operators.coreos.com/v1] - - -Description:: -+ --- -OperatorGroupList is a list of OperatorGroup --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`array (OperatorGroup operators.coreos.com/v1)`] -| List of operatorgroups. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="operatorhublist-config-openshift-io-v1"] -== OperatorHubList [config.openshift.io/v1] - - -Description:: -+ --- -OperatorHubList is a list of OperatorHub --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`array (OperatorHub config.openshift.io/v1)`] -| List of operatorhubs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="operatorlist-operators-coreos-com-v1"] -== OperatorList [operators.coreos.com/v1] - - -Description:: -+ --- -OperatorList is a list of Operator --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`array (Operator operators.coreos.com/v1)`] -| List of operators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="operatorpkilist-network-operator-openshift-io-v1"] -== OperatorPKIList [network.operator.openshift.io/v1] - - -Description:: -+ --- -OperatorPKIList is a list of OperatorPKI --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`array (OperatorPKI network.operator.openshift.io/v1)`] -| List of operatorpkis. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="ownerreference-meta-v1"] -== OwnerReference [meta/v1] - - -Description:: -+ --- -OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. --- - -Type:: - `object` - -Required:: - - `apiVersion` - - `kind` - - `name` - - `uid` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| API version of the referent. - -| `blockOwnerDeletion` -| `boolean` -| If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - -| `controller` -| `boolean` -| If true, this reference points to the managing controller. - -| `kind` -| `string` -| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `name` -| `string` -| Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - -| `uid` -| `string` -| UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - -|=== - -[id="ownerreference_v2-meta-v1"] -== OwnerReference_v2 [meta/v1] - - -Description:: -+ --- -OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. --- - -Type:: - `object` - -Required:: - - `apiVersion` - - `kind` - - `name` - - `uid` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| API version of the referent. - -| `blockOwnerDeletion` -| `boolean` -| If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - -| `controller` -| `boolean` -| If true, this reference points to the managing controller. - -| `kind` -| `string` -| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `name` -| `string` -| Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - -| `uid` -| `string` -| UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids - -|=== - -[id="packagemanifestlist-packages-operators-coreos-com-v1"] -== PackageManifestList [packages.operators.coreos.com/v1] - - -Description:: -+ --- -PackageManifestList is a list of PackageManifest objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`array (PackageManifest packages.operators.coreos.com/v1)`] -| - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="patch-meta-v1"] -== Patch [meta/v1] - - -Description:: -+ --- -Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. --- - -Type:: - `object` - - - -[id="persistentvolumeclaim-core-v1"] -== PersistentVolumeClaim [core/v1] - - -Description:: -+ --- -PersistentVolumeClaim is a user's request for and claim to a persistent volume --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `spec` -| `object` -| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes - -| `status` -| `object` -| PersistentVolumeClaimStatus is the current status of a persistent volume claim. - -|=== -..spec -Description:: -+ --- -PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes --- - -Type:: - `object` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `accessModes` -| `array (string)` -| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - -| `dataSource` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] -| This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. - -| `dataSourceRef` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] -| Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef - allows any non-core object, as well as PersistentVolumeClaim objects. -* While DataSource ignores disallowed values (dropping them), DataSourceRef - preserves all values, and generates an error if a disallowed value is - specified. -(Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled. - -| `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] -| Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources - -| `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] -| A label query over volumes to consider for binding. - -| `storageClassName` -| `string` -| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 - -| `volumeMode` -| `string` -| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. - -| `volumeName` -| `string` -| VolumeName is the binding reference to the PersistentVolume backing this claim. - -|=== -..status -Description:: -+ --- -PersistentVolumeClaimStatus is the current status of a persistent volume claim. --- - -Type:: - `object` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `accessModes` -| `array (string)` -| AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - -| `capacity` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Represents the actual resources of the underlying volume. - -| `conditions` -| xref:../objects/index.adoc#persistentvolumeclaimcondition-core-v1[`array (PersistentVolumeClaimCondition core/v1)`] -| Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. - -| `phase` -| `string` -| Phase represents the current phase of PersistentVolumeClaim. - -|=== - -[id="persistentvolumeclaimcondition-core-v1"] -== PersistentVolumeClaimCondition [core/v1] - - -Description:: -+ --- -PersistentVolumeClaimCondition contails details about state of pvc --- - -Type:: - `object` - -Required:: - - `type` - - `status` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time we probed the condition. - -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time the condition transitioned from one status to another. - -| `message` -| `string` -| Human-readable message indicating details about last transition. - -| `reason` -| `string` -| Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. - -| `status` -| `string` -| - -| `type` -| `string` -| - -|=== - -[id="persistentvolumeclaimlist-core-v1"] -== PersistentVolumeClaimList [core/v1] - - -Description:: -+ --- -PersistentVolumeClaimList is a list of PersistentVolumeClaim items. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../storage_apis/persistentvolumeclaim-core-v1.adoc#persistentvolumeclaim-core-v1[`array (PersistentVolumeClaim core/v1)`] -| A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="persistentvolumeclaimspec-core-v1"] -== PersistentVolumeClaimSpec [core/v1] - - -Description:: -+ --- -PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `accessModes` -| `array (string)` -| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - -| `dataSource` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] -| This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. - -| `dataSourceRef` -| xref:../objects/index.adoc#typedlocalobjectreference-core-v1[`TypedLocalObjectReference core/v1`] -| Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef - allows any non-core object, as well as PersistentVolumeClaim objects. -* While DataSource ignores disallowed values (dropping them), DataSourceRef - preserves all values, and generates an error if a disallowed value is - specified. -(Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled. - -| `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] -| Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources - -| `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] -| A label query over volumes to consider for binding. - -| `storageClassName` -| `string` -| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 - -| `volumeMode` -| `string` -| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. - -| `volumeName` -| `string` -| VolumeName is the binding reference to the PersistentVolume backing this claim. - -|=== - -[id="persistentvolumeclaimtemplate-core-v1"] -== PersistentVolumeClaimTemplate [core/v1] - - -Description:: -+ --- -PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. --- - -Type:: - `object` - -Required:: - - `spec` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. - -| `spec` -| xref:../objects/index.adoc#persistentvolumeclaimspec-core-v1[`PersistentVolumeClaimSpec core/v1`] -| The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. - -|=== - -[id="persistentvolumeclaimvolumesource-core-v1"] -== PersistentVolumeClaimVolumeSource [core/v1] - - -Description:: -+ --- -PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). --- - -Type:: - `object` - -Required:: - - `claimName` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `claimName` -| `string` -| ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - -| `readOnly` -| `boolean` -| Will force the ReadOnly setting in VolumeMounts. Default false. - -|=== - -[id="persistentvolumelist-core-v1"] -== PersistentVolumeList [core/v1] - - -Description:: -+ --- -PersistentVolumeList is a list of PersistentVolume items. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../workloads_apis/persistentvolume-core-v1.adoc#persistentvolume-core-v1[`array (PersistentVolume core/v1)`] -| List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="persistentvolumespec-core-v1"] -== PersistentVolumeSpec [core/v1] - - -Description:: -+ --- -PersistentVolumeSpec is the specification of a persistent volume. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `accessModes` -| `array (string)` -| AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes - -| `awsElasticBlockStore` -| xref:../objects/index.adoc#awselasticblockstorevolumesource-core-v1[`AWSElasticBlockStoreVolumeSource core/v1`] -| AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - -| `azureDisk` -| xref:../objects/index.adoc#azurediskvolumesource-core-v1[`AzureDiskVolumeSource core/v1`] -| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - -| `azureFile` -| xref:../objects/index.adoc#azurefilepersistentvolumesource-core-v1[`AzureFilePersistentVolumeSource core/v1`] -| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - -| `capacity` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity - -| `cephfs` -| xref:../objects/index.adoc#cephfspersistentvolumesource-core-v1[`CephFSPersistentVolumeSource core/v1`] -| CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - -| `cinder` -| xref:../objects/index.adoc#cinderpersistentvolumesource-core-v1[`CinderPersistentVolumeSource core/v1`] -| Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - -| `claimRef` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] -| ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding - -| `csi` -| xref:../objects/index.adoc#csipersistentvolumesource-core-v1[`CSIPersistentVolumeSource core/v1`] -| CSI represents storage that is handled by an external CSI driver (Beta feature). - -| `fc` -| xref:../objects/index.adoc#fcvolumesource-core-v1[`FCVolumeSource core/v1`] -| FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - -| `flexVolume` -| xref:../objects/index.adoc#flexpersistentvolumesource-core-v1[`FlexPersistentVolumeSource core/v1`] -| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - -| `flocker` -| xref:../objects/index.adoc#flockervolumesource-core-v1[`FlockerVolumeSource core/v1`] -| Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running - -| `gcePersistentDisk` -| xref:../objects/index.adoc#gcepersistentdiskvolumesource-core-v1[`GCEPersistentDiskVolumeSource core/v1`] -| GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - -| `glusterfs` -| xref:../objects/index.adoc#glusterfspersistentvolumesource-core-v1[`GlusterfsPersistentVolumeSource core/v1`] -| Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md - -| `hostPath` -| xref:../objects/index.adoc#hostpathvolumesource-core-v1[`HostPathVolumeSource core/v1`] -| HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - -| `iscsi` -| xref:../objects/index.adoc#iscsipersistentvolumesource-core-v1[`ISCSIPersistentVolumeSource core/v1`] -| ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. - -| `local` -| xref:../objects/index.adoc#localvolumesource-core-v1[`LocalVolumeSource core/v1`] -| Local represents directly-attached storage with node affinity - -| `mountOptions` -| `array (string)` -| A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options - -| `nfs` -| xref:../objects/index.adoc#nfsvolumesource-core-v1[`NFSVolumeSource core/v1`] -| NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - -| `nodeAffinity` -| xref:../objects/index.adoc#volumenodeaffinity-core-v1[`VolumeNodeAffinity core/v1`] -| NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. - -| `persistentVolumeReclaimPolicy` -| `string` -| What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming - -| `photonPersistentDisk` -| xref:../objects/index.adoc#photonpersistentdiskvolumesource-core-v1[`PhotonPersistentDiskVolumeSource core/v1`] -| PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - -| `portworxVolume` -| xref:../objects/index.adoc#portworxvolumesource-core-v1[`PortworxVolumeSource core/v1`] -| PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - -| `quobyte` -| xref:../objects/index.adoc#quobytevolumesource-core-v1[`QuobyteVolumeSource core/v1`] -| Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - -| `rbd` -| xref:../objects/index.adoc#rbdpersistentvolumesource-core-v1[`RBDPersistentVolumeSource core/v1`] -| RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md - -| `scaleIO` -| xref:../objects/index.adoc#scaleiopersistentvolumesource-core-v1[`ScaleIOPersistentVolumeSource core/v1`] -| ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - -| `storageClassName` -| `string` -| Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. - -| `storageos` -| xref:../objects/index.adoc#storageospersistentvolumesource-core-v1[`StorageOSPersistentVolumeSource core/v1`] -| StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md - -| `volumeMode` -| `string` -| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. - -| `vsphereVolume` -| xref:../objects/index.adoc#vspherevirtualdiskvolumesource-core-v1[`VsphereVirtualDiskVolumeSource core/v1`] -| VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - -|=== - -[id="photonpersistentdiskvolumesource-core-v1"] -== PhotonPersistentDiskVolumeSource [core/v1] - - -Description:: -+ --- -Represents a Photon Controller persistent disk resource. --- - -Type:: - `object` - -Required:: - - `pdID` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `fsType` -| `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - -| `pdID` -| `string` -| ID that identifies Photon Controller persistent disk - -|=== - -[id="podaffinity-core-v1"] -== PodAffinity [core/v1] - - -Description:: -+ --- -Pod affinity is a group of inter pod affinity scheduling rules. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `preferredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#weightedpodaffinityterm-core-v1[`array (WeightedPodAffinityTerm core/v1)`] -| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. - -| `requiredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#podaffinityterm-core-v1[`array (PodAffinityTerm core/v1)`] -| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. - -|=== - -[id="podaffinityterm-core-v1"] -== PodAffinityTerm [core/v1] - - -Description:: -+ --- -Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running --- - -Type:: - `object` - -Required:: - - `topologyKey` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `labelSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] -| A label query over a set of resources, in this case pods. - -| `namespaceSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] -| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. - -| `namespaces` -| `array (string)` -| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" - -| `topologyKey` -| `string` -| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. - -|=== - -[id="podantiaffinity-core-v1"] -== PodAntiAffinity [core/v1] - - -Description:: -+ --- -Pod anti affinity is a group of inter pod anti affinity scheduling rules. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `preferredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#weightedpodaffinityterm-core-v1[`array (WeightedPodAffinityTerm core/v1)`] -| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. - -| `requiredDuringSchedulingIgnoredDuringExecution` -| xref:../objects/index.adoc#podaffinityterm-core-v1[`array (PodAffinityTerm core/v1)`] -| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. - -|=== - -[id="podcondition-core-v1"] -== PodCondition [core/v1] - - -Description:: -+ --- -PodCondition contains details for the current condition of this pod. --- - -Type:: - `object` - -Required:: - - `type` - - `status` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time we probed the condition. - -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| Last time the condition transitioned from one status to another. - -| `message` -| `string` -| Human-readable message indicating details about last transition. - -| `reason` -| `string` -| Unique, one-word, CamelCase reason for the condition's last transition. - -| `status` -| `string` -| Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions - -| `type` -| `string` -| Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions - -|=== - -[id="poddisruptionbudgetlist-policy-v1"] -== PodDisruptionBudgetList [policy/v1] - - -Description:: -+ --- -PodDisruptionBudgetList is a collection of PodDisruptionBudgets. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`array (PodDisruptionBudget policy/v1)`] -| Items is a list of PodDisruptionBudgets - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="poddnsconfig-core-v1"] -== PodDNSConfig [core/v1] - - -Description:: -+ --- -PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `nameservers` -| `array (string)` -| A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. - -| `options` -| xref:../objects/index.adoc#poddnsconfigoption-core-v1[`array (PodDNSConfigOption core/v1)`] -| A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. - -| `searches` -| `array (string)` -| A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. - -|=== - -[id="poddnsconfigoption-core-v1"] -== PodDNSConfigOption [core/v1] - - -Description:: -+ --- -PodDNSConfigOption defines DNS resolver options of a pod. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `name` -| `string` -| Required. - -| `value` -| `string` -| - -|=== - -[id="podip-core-v1"] -== PodIP [core/v1] - - -Description:: -+ --- -IP address information for entries in the (plural) PodIPs field. Each entry includes: - IP: An IP address allocated to the pod. Routable at least within the cluster. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `ip` -| `string` -| ip is an IP address (IPv4 or IPv6) assigned to the pod - -|=== - -[id="podlist-core-v1"] -== PodList [core/v1] - - -Description:: -+ --- -PodList is a list of Pods. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../workloads_apis/pod-core-v1.adoc#pod-core-v1[`array (Pod core/v1)`] -| List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="podmonitorlist-monitoring-coreos-com-v1"] -== PodMonitorList [monitoring.coreos.com/v1] - - -Description:: -+ --- -PodMonitorList is a list of PodMonitor --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc#podmonitor-monitoring-coreos-com-v1[`array (PodMonitor monitoring.coreos.com/v1)`] -| List of podmonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="podnetworkconnectivitychecklist-controlplane-operator-openshift-io-v1alpha1"] -== PodNetworkConnectivityCheckList [controlplane.operator.openshift.io/v1alpha1] - - -Description:: -+ --- -PodNetworkConnectivityCheckList is a list of PodNetworkConnectivityCheck --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`array (PodNetworkConnectivityCheck controlplane.operator.openshift.io/v1alpha1)`] -| List of podnetworkconnectivitychecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="podreadinessgate-core-v1"] -== PodReadinessGate [core/v1] - - -Description:: -+ --- -PodReadinessGate contains the reference to a pod condition --- - -Type:: - `object` - -Required:: - - `conditionType` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `conditionType` -| `string` -| ConditionType refers to a condition in the pod's condition list with matching type. - -|=== - -[id="podsecuritycontext-core-v1"] -== PodSecurityContext [core/v1] - - -Description:: -+ --- -PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `fsGroup` -| `integer` -| A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: - -1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- - -If unset, the Kubelet will not modify the ownership and permissions of any volume. - -| `fsGroupChangePolicy` -| `string` -| fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. - -| `runAsGroup` -| `integer` -| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - -| `runAsNonRoot` -| `boolean` -| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - -| `runAsUser` -| `integer` -| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - -| `seLinuxOptions` -| xref:../objects/index.adoc#selinuxoptions-core-v1[`SELinuxOptions core/v1`] -| The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. - -| `seccompProfile` -| xref:../objects/index.adoc#seccompprofile-core-v1[`SeccompProfile core/v1`] -| The seccomp options to use by the containers in this pod. - -| `supplementalGroups` -| `array (integer)` -| A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. - -| `sysctls` -| xref:../objects/index.adoc#sysctl-core-v1[`array (Sysctl core/v1)`] -| Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. - -| `windowsOptions` -| xref:../objects/index.adoc#windowssecuritycontextoptions-core-v1[`WindowsSecurityContextOptions core/v1`] -| The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - -|=== - -[id="podspec-core-v1"] -== PodSpec [core/v1] - - -Description:: -+ --- -PodSpec is a description of a pod. --- - -Type:: - `object` - -Required:: - - `containers` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `activeDeadlineSeconds` -| `integer` -| Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. - -| `affinity` -| xref:../objects/index.adoc#affinity-core-v1[`Affinity core/v1`] -| If specified, the pod's scheduling constraints - -| `automountServiceAccountToken` -| `boolean` -| AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. - -| `containers` -| xref:../objects/index.adoc#container-core-v1[`array (Container core/v1)`] -| List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. - -| `dnsConfig` -| xref:../objects/index.adoc#poddnsconfig-core-v1[`PodDNSConfig core/v1`] -| Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. - -| `dnsPolicy` -| `string` -| Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. - -| `enableServiceLinks` -| `boolean` -| EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. - -| `ephemeralContainers` -| xref:../objects/index.adoc#ephemeralcontainer-core-v1[`array (EphemeralContainer core/v1)`] -| List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. - -| `hostAliases` -| xref:../objects/index.adoc#hostalias-core-v1[`array (HostAlias core/v1)`] -| HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. - -| `hostIPC` -| `boolean` -| Use the host's ipc namespace. Optional: Default to false. - -| `hostNetwork` -| `boolean` -| Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. - -| `hostPID` -| `boolean` -| Use the host's pid namespace. Optional: Default to false. - -| `hostname` -| `string` -| Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. - -| `imagePullSecrets` -| xref:../objects/index.adoc#localobjectreference-core-v1[`array (LocalObjectReference core/v1)`] -| ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod - -| `initContainers` -| xref:../objects/index.adoc#container-core-v1[`array (Container core/v1)`] -| List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ - -| `nodeName` -| `string` -| NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. - -| `nodeSelector` -| `object (string)` -| NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ - -| `overhead` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature. - -| `preemptionPolicy` -| `string` -| PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. - -| `priority` -| `integer` -| The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. - -| `priorityClassName` -| `string` -| If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. - -| `readinessGates` -| xref:../objects/index.adoc#podreadinessgate-core-v1[`array (PodReadinessGate core/v1)`] -| If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates - -| `restartPolicy` -| `string` -| Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy - -| `runtimeClassName` -| `string` -| RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14. - -| `schedulerName` -| `string` -| If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. - -| `securityContext` -| xref:../objects/index.adoc#podsecuritycontext-core-v1[`PodSecurityContext core/v1`] -| SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. - -| `serviceAccount` -| `string` -| DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. - -| `serviceAccountName` -| `string` -| ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - -| `setHostnameAsFQDN` -| `boolean` -| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. - -| `shareProcessNamespace` -| `boolean` -| Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. - -| `subdomain` -| `string` -| If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. - -| `terminationGracePeriodSeconds` -| `integer` -| Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. - -| `tolerations` -| xref:../objects/index.adoc#toleration-core-v1[`array (Toleration core/v1)`] -| If specified, the pod's tolerations. - -| `topologySpreadConstraints` -| xref:../objects/index.adoc#topologyspreadconstraint-core-v1[`array (TopologySpreadConstraint core/v1)`] -| TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. - -| `volumes` -| xref:../objects/index.adoc#volume-core-v1[`array (Volume core/v1)`] -| List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes - -|=== - -[id="podtemplatelist-core-v1"] -== PodTemplateList [core/v1] - - -Description:: -+ --- -PodTemplateList is a list of PodTemplates. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../template_apis/podtemplate-core-v1.adoc#podtemplate-core-v1[`array (PodTemplate core/v1)`] -| List of pod templates - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="podtemplatespec-core-v1"] -== PodTemplateSpec [core/v1] - - -Description:: -+ --- -PodTemplateSpec describes the data a pod should have when created from a template --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `spec` -| xref:../objects/index.adoc#podspec-core-v1[`PodSpec core/v1`] -| Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - -|=== - -[id="portstatus-core-v1"] -== PortStatus [core/v1] - - -Description:: -+ --- - --- - -Type:: - `object` - -Required:: - - `port` - - `protocol` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `error` -| `string` -| Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use - CamelCase names -- cloud provider specific error values must have names that comply with the - format foo.example.com/CamelCase. - -| `port` -| `integer` -| Port is the port number of the service port of which status is recorded here - -| `protocol` -| `string` -| Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP" - -|=== - -[id="portworxvolumesource-core-v1"] -== PortworxVolumeSource [core/v1] - - -Description:: -+ --- -PortworxVolumeSource represents a Portworx volume resource. --- - -Type:: - `object` - -Required:: - - `volumeID` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `fsType` -| `string` -| FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. - -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - -| `volumeID` -| `string` -| VolumeID uniquely identifies a Portworx volume - -|=== - -[id="preferredschedulingterm-core-v1"] -== PreferredSchedulingTerm [core/v1] - - -Description:: -+ --- -An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). --- - -Type:: - `object` - -Required:: - - `weight` - - `preference` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `preference` -| xref:../objects/index.adoc#nodeselectorterm-core-v1[`NodeSelectorTerm core/v1`] -| A node selector term, associated with the corresponding weight. - -| `weight` -| `integer` -| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. - -|=== - -[id="priorityclasslist-scheduling-k8s-io-v1"] -== PriorityClassList [scheduling.k8s.io/v1] - - -Description:: -+ --- -PriorityClassList is a collection of priority classes. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`array (PriorityClass scheduling.k8s.io/v1)`] -| items is the list of PriorityClasses - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="prioritylevelconfigurationlist-flowcontrol-apiserver-k8s-io-v1beta1"] -== PriorityLevelConfigurationList [flowcontrol.apiserver.k8s.io/v1beta1] - - -Description:: -+ --- -PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`array (PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1)`] -| `items` is a list of request-priorities. - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -|=== - -[id="probe-core-v1"] -== Probe [core/v1] - - -Description:: -+ --- -Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `exec` -| xref:../objects/index.adoc#execaction-core-v1[`ExecAction core/v1`] -| One and only one of the following should be specified. Exec specifies the action to take. - -| `failureThreshold` -| `integer` -| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. - -| `httpGet` -| xref:../objects/index.adoc#httpgetaction-core-v1[`HTTPGetAction core/v1`] -| HTTPGet specifies the http request to perform. - -| `initialDelaySeconds` -| `integer` -| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - -| `periodSeconds` -| `integer` -| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. - -| `successThreshold` -| `integer` -| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. - -| `tcpSocket` -| xref:../objects/index.adoc#tcpsocketaction-core-v1[`TCPSocketAction core/v1`] -| TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported - -| `terminationGracePeriodSeconds` -| `integer` -| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. - -| `timeoutSeconds` -| `integer` -| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - -|=== - -[id="probelist-monitoring-coreos-com-v1"] -== ProbeList [monitoring.coreos.com/v1] - - -Description:: -+ --- -ProbeList is a list of Probe --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../monitoring_apis/probe-monitoring-coreos-com-v1.adoc#probe-monitoring-coreos-com-v1[`array (Probe monitoring.coreos.com/v1)`] -| List of probes. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="profilelist-tuned-openshift-io-v1"] -== ProfileList [tuned.openshift.io/v1] - - -Description:: -+ --- -ProfileList is a list of Profile --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`array (Profile tuned.openshift.io/v1)`] -| List of profiles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="projectedvolumesource-core-v1"] -== ProjectedVolumeSource [core/v1] - - -Description:: -+ --- -Represents a projected volume source --- - -Type:: - `object` - - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `defaultMode` -| `integer` -| Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. - -| `sources` -| xref:../objects/index.adoc#volumeprojection-core-v1[`array (VolumeProjection core/v1)`] -| list of volume projections - -|=== - -[id="projectlist-config-openshift-io-v1"] -== ProjectList [config.openshift.io/v1] - - -Description:: -+ --- -ProjectList is a list of Project --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`array (Project config.openshift.io/v1)`] -| List of projects. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -|=== - -[id="projectlist-project-openshift-io-v1"] -== ProjectList [project.openshift.io/v1] - - -Description:: -+ --- -ProjectList is a list of Project objects. --- - -Type:: - `object` - -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`array (Project project.openshift.io/v1)`] -| Items is the list of projects - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| - -|=== - -[id="prometheuslist-monitoring-coreos-com-v1"] -== PrometheusList [monitoring.coreos.com/v1] - - -Description:: -+ --- -PrometheusList is a list of Prometheus --- +| Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names -Type:: - `object` +| `namespace` +| `string` +| Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. -Required:: - - `items` +Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces -[discrete] -=== Specification +| `ownerReferences` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference_v2[`array (OwnerReference_v2)`] +| List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `resourceVersion` +| `string` +| An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. -| `apiVersion` +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `selfLink` | `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| SelfLink is a URL representing this object. Populated by the system. Read-only. -| `items` -| xref:../monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc#prometheus-monitoring-coreos-com-v1[`array (Prometheus monitoring.coreos.com/v1)`] -| List of prometheuses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -| `kind` +| `uid` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |=== -[id="prometheusrulelist-monitoring-coreos-com-v1"] -== PrometheusRuleList [monitoring.coreos.com/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.Patch"] +== io.k8s.apimachinery.pkg.apis.meta.v1.Patch schema Description:: + -- -PrometheusRuleList is a list of PrometheusRule +Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. -- Type:: `object` -Required:: - - `items` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc#prometheusrule-monitoring-coreos-com-v1[`array (PrometheusRule monitoring.coreos.com/v1)`] -| List of prometheusrules. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md - -| `kind` -| `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -|=== -[id="provisioninglist-metal3-io-v1alpha1"] -== ProvisioningList [metal3.io/v1alpha1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.Status"] +== io.k8s.apimachinery.pkg.apis.meta.v1.Status schema Description:: + -- -ProvisioningList is a list of Provisioning +Status is a return value for calls that don't return other objects. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11164,38 +5820,52 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`array (Provisioning metal3.io/v1alpha1)`] -| List of provisionings. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `code` +| `integer` +| Suggested HTTP return code for this status, 0 if not set. + +| `details` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails[`StatusDetails`] +| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `message` +| `string` +| A human-readable description of the status of this operation. + | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `reason` +| `string` +| A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. + +| `status` +| `string` +| Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + |=== -[id="proxylist-config-openshift-io-v1"] -== ProxyList [config.openshift.io/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2"] +== io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2 schema Description:: + -- -ProxyList is a list of Proxy +Status is a return value for calls that don't return other objects. -- Type:: `object` -Required:: - - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11205,158 +5875,91 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `items` -| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`array (Proxy config.openshift.io/v1)`] -| List of proxies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| `code` +| `integer` +| Suggested HTTP return code for this status, 0 if not set. + +| `details` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails_v2[`StatusDetails_v2`] +| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `message` +| `string` +| A human-readable description of the status of this operation. + | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -|=== - -[id="quantity-api-none"] -== Quantity [api/none] - - -Description:: -+ --- -Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. - -The serialization format is: - - ::= - (Note that may be empty, from the "" case in .) - ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei - (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) - ::= m | "" | k | M | G | T | P | E - (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) - ::= "e" | "E" - -No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. - -When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. - -Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: - a. No precision is lost - b. No fractional digits will be emitted - c. The exponent (or suffix) is as large as possible. -The sign will be omitted unless the number is negative. - -Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" - -Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. - -Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) - -This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. --- - -Type:: - `string` +| `reason` +| `string` +| A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +| `status` +| `string` +| Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +|=== -[id="quobytevolumesource-core-v1"] -== QuobyteVolumeSource [core/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.Time"] +== io.k8s.apimachinery.pkg.apis.meta.v1.Time schema Description:: + -- -Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. +Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. -- Type:: - `object` - -Required:: - - `registry` - - `volume` - -[discrete] -=== Specification - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `group` -| `string` -| Group to map volume access to Default is no group - -| `readOnly` -| `boolean` -| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. - -| `registry` -| `string` -| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes - -| `tenant` -| `string` -| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin - -| `user` -| `string` -| User to map volume access to Defaults to serivceaccount user + `string` -| `volume` -| `string` -| Volume is a string that references an already created Quobyte volume by name. -|=== -[id="rangeallocationlist-security-openshift-io-v1"] -== RangeAllocationList [security.openshift.io/v1] +[id="io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent"] +== io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent schema Description:: + -- -RangeAllocationList is a list of RangeAllocations objects +Event represents a single event to a watched resource. -- Type:: `object` Required:: - - `items` + - `type` + - `object` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiVersion` -| `string` -| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - -| `items` -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`array (RangeAllocation security.openshift.io/v1)`] -| List of RangeAllocations. +| `object` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] +| Object is: + * If Type is Added or Modified: the new state of the object. + * If Type is Deleted: the state of the object immediately before deletion. + * If Type is Error: *Status is recommended; other types may make sense + depending on context. -| `kind` +| `type` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] | |=== -[id="rawextension-pkg-none"] -== RawExtension [pkg/none] +[id="io.k8s.apimachinery.pkg.runtime.RawExtension"] +== io.k8s.apimachinery.pkg.runtime.RawExtension schema Description:: @@ -11397,130 +6000,152 @@ Type:: -[id="rbdpersistentvolumesource-core-v1"] -== RBDPersistentVolumeSource [core/v1] +[id="io.k8s.apimachinery.pkg.util.intstr.IntOrString"] +== io.k8s.apimachinery.pkg.util.intstr.IntOrString schema + + +Description:: ++ +-- +IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. +-- + +Type:: + `string` + + + +[id="io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList"] +== io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList schema Description:: + -- -Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +APIServiceList is a list of APIService objects. -- Type:: `object` Required:: - - `monitors` - - `image` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` -| `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd - -| `image` -| `string` -| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - -| `keyring` +| `apiVersion` | `string` -| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `monitors` -| `array (string)` -| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| `items` +| xref:../extension_apis/apiservice-apiregistration-k8s-io-v1.adoc#apiservice-apiregistration-k8s-io-v1[`array (APIService)`] +| Items is the list of APIService -| `pool` +| `kind` | `string` -| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - -| `readOnly` -| `boolean` -| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it - -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `user` -| `string` -| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |=== -[id="rbdvolumesource-core-v1"] -== RBDVolumeSource [core/v1] +[id="io.k8s.migration.v1alpha1.StorageStateList"] +== io.k8s.migration.v1alpha1.StorageStateList schema Description:: + -- -Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +StorageStateList is a list of StorageState -- Type:: `object` Required:: - - `monitors` - - `image` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `image` -| `string` -| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| `items` +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`array (StorageState)`] +| List of storagestates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `keyring` +| `kind` | `string` -| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `monitors` -| `array (string)` -| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `pool` -| `string` -| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +|=== -| `readOnly` -| `boolean` -| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +[id="io.k8s.migration.v1alpha1.StorageVersionMigrationList"] +== io.k8s.migration.v1alpha1.StorageVersionMigrationList schema + + +Description:: ++ +-- +StorageVersionMigrationList is a list of StorageVersionMigration +-- + +Type:: + `object` + +Required:: + - `items` + +[discrete] +=== Schema + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| `items` +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`array (StorageVersionMigration)`] +| List of storageversionmigrations. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `user` +| `kind` | `string` -| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="replicasetlist-apps-v1"] -== ReplicaSetList [apps/v1] +[id="io.k8s.storage.snapshot.v1.VolumeSnapshotClassList"] +== io.k8s.storage.snapshot.v1.VolumeSnapshotClassList schema Description:: + -- -ReplicaSetList is a collection of ReplicaSets. +VolumeSnapshotClassList is a list of VolumeSnapshotClass -- Type:: @@ -11530,7 +6155,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11541,73 +6166,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`array (ReplicaSet apps/v1)`] -| List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`array (VolumeSnapshotClass)`] +| List of volumesnapshotclasses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="replicationcontrollercondition-core-v1"] -== ReplicationControllerCondition [core/v1] +[id="io.k8s.storage.snapshot.v1.VolumeSnapshotContentList"] +== io.k8s.storage.snapshot.v1.VolumeSnapshotContentList schema Description:: + -- -ReplicationControllerCondition describes the state of a replication controller at a certain point. +VolumeSnapshotContentList is a list of VolumeSnapshotContent -- Type:: `object` Required:: - - `type` - - `status` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| The last time the condition transitioned from one status to another. - -| `message` +| `apiVersion` | `string` -| A human readable message indicating details about the transition. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `reason` -| `string` -| The reason for the condition's last transition. +| `items` +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`array (VolumeSnapshotContent)`] +| List of volumesnapshotcontents. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `status` +| `kind` | `string` -| Status of the condition, one of True, False, Unknown. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `type` -| `string` -| Type of replication controller condition. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="replicationcontrollerlist-core-v1"] -== ReplicationControllerList [core/v1] +[id="io.k8s.storage.snapshot.v1.VolumeSnapshotList"] +== io.k8s.storage.snapshot.v1.VolumeSnapshotList schema Description:: + -- -ReplicationControllerList is a collection of replication controllers. +VolumeSnapshotList is a list of VolumeSnapshot -- Type:: @@ -11617,7 +6237,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11628,64 +6248,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/replicationcontroller-core-v1.adoc#replicationcontroller-core-v1[`array (ReplicationController core/v1)`] -| List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`array (VolumeSnapshot)`] +| List of volumesnapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="resourcefieldselector-core-v1"] -== ResourceFieldSelector [core/v1] +[id="io.metal3.v1alpha1.BareMetalHostList"] +== io.metal3.v1alpha1.BareMetalHostList schema Description:: + -- -ResourceFieldSelector represents container resources (cpu, memory) and their output format +BareMetalHostList is a list of BareMetalHost -- Type:: `object` Required:: - - `resource` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `containerName` +| `apiVersion` | `string` -| Container name: required for volumes, optional for env vars +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `divisor` -| xref:../objects/index.adoc#quantity-api-none[`Quantity api/none`] -| Specifies the output format of the exposed resources, defaults to "1" +| `items` +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`array (BareMetalHost)`] +| List of baremetalhosts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `resource` +| `kind` | `string` -| Required: resource to select +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="resourcequotalist-core-v1"] -== ResourceQuotaList [core/v1] +[id="io.metal3.v1alpha1.FirmwareSchemaList"] +== io.metal3.v1alpha1.FirmwareSchemaList schema Description:: + -- -ResourceQuotaList is a list of ResourceQuota items. +FirmwareSchemaList is a list of FirmwareSchema -- Type:: @@ -11695,7 +6319,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11706,124 +6330,150 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../schedule_and_quota_apis/resourcequota-core-v1.adoc#resourcequota-core-v1[`array (ResourceQuota core/v1)`] -| Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`array (FirmwareSchema)`] +| List of firmwareschemas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="resourcequotaspec-core-v1"] -== ResourceQuotaSpec [core/v1] +[id="io.metal3.v1alpha1.HostFirmwareSettingsList"] +== io.metal3.v1alpha1.HostFirmwareSettingsList schema Description:: + -- -ResourceQuotaSpec defines the desired hard limits to enforce for Quota. +HostFirmwareSettingsList is a list of HostFirmwareSettings -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `hard` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `scopeSelector` -| xref:../objects/index.adoc#scopeselector-core-v1[`ScopeSelector core/v1`] -| scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. +| `items` +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`array (HostFirmwareSettings)`] +| List of hostfirmwaresettings. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `scopes` -| `array (string)` -| A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="resourcequotastatus-core-v1"] -== ResourceQuotaStatus [core/v1] +[id="io.metal3.v1alpha1.ProvisioningList"] +== io.metal3.v1alpha1.ProvisioningList schema Description:: + -- -ResourceQuotaStatus defines the enforced hard limits and observed use. +ProvisioningList is a list of Provisioning -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `hard` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `used` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Used is the current observed total usage of the resource in the namespace. +| `items` +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`array (Provisioning)`] +| List of provisionings. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="resourcerequirements-core-v1"] -== ResourceRequirements [core/v1] +[id="io.openshift.apiserver.v1.APIRequestCountList"] +== io.openshift.apiserver.v1.APIRequestCountList schema Description:: + -- -ResourceRequirements describes the compute resource requirements. +APIRequestCountList is a list of APIRequestCount -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `limits` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `requests` -| xref:../objects/index.adoc#quantity-api-none[`object (Quantity api/none)`] -| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ +| `items` +| xref:../metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc#apirequestcount-apiserver-openshift-io-v1[`array (APIRequestCount)`] +| List of apirequestcounts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="rolebindinglist-authorization-openshift-io-v1"] -== RoleBindingList [authorization.openshift.io/v1] +[id="io.openshift.authorization.v1.RoleBindingRestrictionList"] +== io.openshift.authorization.v1.RoleBindingRestrictionList schema Description:: + -- -RoleBindingList is a collection of RoleBindings +RoleBindingRestrictionList is a list of RoleBindingRestriction -- Type:: @@ -11833,7 +6483,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11844,27 +6494,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`array (RoleBinding authorization.openshift.io/v1)`] -| Items is a list of RoleBindings +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`array (RoleBindingRestriction)`] +| List of rolebindingrestrictions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="rolebindinglist-rbac-authorization-k8s-io-v1"] -== RoleBindingList [rbac.authorization.k8s.io/v1] +[id="io.openshift.autoscaling.v1.ClusterAutoscalerList"] +== io.openshift.autoscaling.v1.ClusterAutoscalerList schema Description:: + -- -RoleBindingList is a collection of RoleBindings +ClusterAutoscalerList is a list of ClusterAutoscaler -- Type:: @@ -11874,7 +6524,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11885,27 +6535,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`array (RoleBinding rbac.authorization.k8s.io/v1)`] -| Items is a list of RoleBindings +| xref:../autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc#clusterautoscaler-autoscaling-openshift-io-v1[`array (ClusterAutoscaler)`] +| List of clusterautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="rolebindingrestrictionlist-authorization-openshift-io-v1"] -== RoleBindingRestrictionList [authorization.openshift.io/v1] +[id="io.openshift.autoscaling.v1beta1.MachineAutoscalerList"] +== io.openshift.autoscaling.v1beta1.MachineAutoscalerList schema Description:: + -- -RoleBindingRestrictionList is a list of RoleBindingRestriction +MachineAutoscalerList is a list of MachineAutoscaler -- Type:: @@ -11915,7 +6565,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11926,27 +6576,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`array (RoleBindingRestriction authorization.openshift.io/v1)`] -| List of rolebindingrestrictions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc#machineautoscaler-autoscaling-openshift-io-v1beta1[`array (MachineAutoscaler)`] +| List of machineautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="rolelist-authorization-openshift-io-v1"] -== RoleList [authorization.openshift.io/v1] +[id="io.openshift.cloudcredential.v1.CredentialsRequestList"] +== io.openshift.cloudcredential.v1.CredentialsRequestList schema Description:: + -- -RoleList is a collection of Roles +CredentialsRequestList is a list of CredentialsRequest -- Type:: @@ -11956,7 +6606,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -11967,27 +6617,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`array (Role authorization.openshift.io/v1)`] -| Items is a list of Roles +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`array (CredentialsRequest)`] +| List of credentialsrequests. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="rolelist-rbac-authorization-k8s-io-v1"] -== RoleList [rbac.authorization.k8s.io/v1] +[id="io.openshift.config.v1.APIServerList"] +== io.openshift.config.v1.APIServerList schema Description:: + -- -RoleList is a collection of Roles +APIServerList is a list of APIServer -- Type:: @@ -11997,7 +6647,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12008,27 +6658,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`array (Role rbac.authorization.k8s.io/v1)`] -| Items is a list of Roles +| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`array (APIServer)`] +| List of apiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard object's metadata. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="routelist-route-openshift-io-v1"] -== RouteList [route.openshift.io/v1] +[id="io.openshift.config.v1.AuthenticationList"] +== io.openshift.config.v1.AuthenticationList schema Description:: + -- -RouteList is a collection of Routes. +AuthenticationList is a list of Authentication -- Type:: @@ -12038,7 +6688,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12049,27 +6699,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`array (Route route.openshift.io/v1)`] -| items is a list of routes +| xref:../config_apis/authentication-config-openshift-io-v1.adoc#authentication-config-openshift-io-v1[`array (Authentication)`] +| List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="runtimeclasslist-node-k8s-io-v1"] -== RuntimeClassList [node.k8s.io/v1] +[id="io.openshift.config.v1.BuildList"] +== io.openshift.config.v1.BuildList schema Description:: + -- -RuntimeClassList is a list of RuntimeClass objects. +BuildList is a list of Build -- Type:: @@ -12079,7 +6729,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12090,35 +6740,37 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../node_apis/runtimeclass-node-k8s-io-v1.adoc#runtimeclass-node-k8s-io-v1[`array (RuntimeClass node.k8s.io/v1)`] -| Items is a list of schema objects. +| xref:../config_apis/build-config-openshift-io-v1.adoc#build-config-openshift-io-v1[`array (Build)`] +| List of builds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scale-autoscaling-v1"] -== Scale [autoscaling/v1] +[id="io.openshift.config.v1.ClusterOperatorList"] +== io.openshift.config.v1.ClusterOperatorList schema Description:: + -- -Scale represents a scaling request for a resource. +ClusterOperatorList is a list of ClusterOperator -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12128,40 +6780,38 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../config_apis/clusteroperator-config-openshift-io-v1.adoc#clusteroperator-config-openshift-io-v1[`array (ClusterOperator)`] +| List of clusteroperators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - -| `spec` -| xref:../objects/index.adoc#scalespec-autoscaling-v1[`ScaleSpec autoscaling/v1`] -| defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. - -| `status` -| xref:../objects/index.adoc#scalestatus-autoscaling-v1[`ScaleStatus autoscaling/v1`] -| current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scale-extensions-v1beta1"] -== Scale [extensions/v1beta1] +[id="io.openshift.config.v1.ClusterVersionList"] +== io.openshift.config.v1.ClusterVersionList schema Description:: + -- -represents a scaling request for a resource. +ClusterVersionList is a list of ClusterVersion -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12171,40 +6821,38 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../config_apis/clusterversion-config-openshift-io-v1.adoc#clusterversion-config-openshift-io-v1[`array (ClusterVersion)`] +| List of clusterversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - -| `spec` -| xref:../objects/index.adoc#scalespec-extensions-v1beta1[`ScaleSpec extensions/v1beta1`] -| defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. - -| `status` -| xref:../objects/index.adoc#scalestatus-extensions-v1beta1[`ScaleStatus extensions/v1beta1`] -| current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scale_v2-autoscaling-v1"] -== Scale_v2 [autoscaling/v1] +[id="io.openshift.config.v1.ConsoleList"] +== io.openshift.config.v1.ConsoleList schema Description:: + -- -Scale represents a scaling request for a resource. +ConsoleList is a list of Console -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12214,166 +6862,110 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../config_apis/console-config-openshift-io-v1.adoc#console-config-openshift-io-v1[`array (Console)`] +| List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] -| Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. - -| `spec` -| xref:../objects/index.adoc#scalespec-autoscaling-v1[`ScaleSpec autoscaling/v1`] -| defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. - -| `status` -| xref:../objects/index.adoc#scalestatus-autoscaling-v1[`ScaleStatus autoscaling/v1`] -| current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scaleiopersistentvolumesource-core-v1"] -== ScaleIOPersistentVolumeSource [core/v1] +[id="io.openshift.config.v1.DNSList"] +== io.openshift.config.v1.DNSList schema Description:: + -- -ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume +DNSList is a list of DNS -- Type:: `object` Required:: - - `gateway` - - `system` - - `secretRef` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` -| `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" - -| `gateway` -| `string` -| The host address of the ScaleIO API Gateway. - -| `protectionDomain` -| `string` -| The name of the ScaleIO Protection Domain for the configured storage. - -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - -| `secretRef` -| xref:../objects/index.adoc#secretreference-core-v1[`SecretReference core/v1`] -| SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. - -| `sslEnabled` -| `boolean` -| Flag to enable/disable SSL communication with Gateway, default false - -| `storageMode` +| `apiVersion` | `string` -| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `storagePool` -| `string` -| The ScaleIO Storage Pool associated with the protection domain. +| `items` +| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`array (DNS)`] +| List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `system` +| `kind` | `string` -| The name of the storage system as configured in ScaleIO. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `volumeName` -| `string` -| The name of a volume already created in the ScaleIO system that is associated with this volume source. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scaleiovolumesource-core-v1"] -== ScaleIOVolumeSource [core/v1] +[id="io.openshift.config.v1.FeatureGateList"] +== io.openshift.config.v1.FeatureGateList schema Description:: + -- -ScaleIOVolumeSource represents a persistent ScaleIO volume +FeatureGateList is a list of FeatureGate -- Type:: `object` Required:: - - `gateway` - - `system` - - `secretRef` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` -| `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". - -| `gateway` -| `string` -| The host address of the ScaleIO API Gateway. - -| `protectionDomain` -| `string` -| The name of the ScaleIO Protection Domain for the configured storage. - -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. - -| `sslEnabled` -| `boolean` -| Flag to enable/disable SSL communication with Gateway, default false - -| `storageMode` +| `apiVersion` | `string` -| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `storagePool` -| `string` -| The ScaleIO Storage Pool associated with the protection domain. +| `items` +| xref:../config_apis/featuregate-config-openshift-io-v1.adoc#featuregate-config-openshift-io-v1[`array (FeatureGate)`] +| List of featuregates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `system` +| `kind` | `string` -| The name of the storage system as configured in ScaleIO. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `volumeName` -| `string` -| The name of a volume already created in the ScaleIO system that is associated with this volume source. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="schedulerlist-config-openshift-io-v1"] -== SchedulerList [config.openshift.io/v1] +[id="io.openshift.config.v1.ImageContentPolicyList"] +== io.openshift.config.v1.ImageContentPolicyList schema Description:: + -- -SchedulerList is a list of Scheduler +ImageContentPolicyList is a list of ImageContentPolicy -- Type:: @@ -12383,7 +6975,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12394,197 +6986,232 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`array (Scheduler config.openshift.io/v1)`] -| List of schedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../config_apis/imagecontentpolicy-config-openshift-io-v1.adoc#imagecontentpolicy-config-openshift-io-v1[`array (ImageContentPolicy)`] +| List of imagecontentpolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scopedresourceselectorrequirement-core-v1"] -== ScopedResourceSelectorRequirement [core/v1] +[id="io.openshift.config.v1.ImageList"] +== io.openshift.config.v1.ImageList schema Description:: + -- -A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. +ImageList is a list of Image -- Type:: `object` Required:: - - `scopeName` - - `operator` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `operator` +| `apiVersion` | `string` -| Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `scopeName` +| `items` +| xref:../config_apis/image-config-openshift-io-v1.adoc#image-config-openshift-io-v1[`array (Image)`] +| List of images. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| The name of the scope that the selector applies to. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `values` -| `array (string)` -| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="scopeselector-core-v1"] -== ScopeSelector [core/v1] +[id="io.openshift.config.v1.InfrastructureList"] +== io.openshift.config.v1.InfrastructureList schema Description:: + -- -A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. +InfrastructureList is a list of Infrastructure -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `matchExpressions` -| xref:../objects/index.adoc#scopedresourceselectorrequirement-core-v1[`array (ScopedResourceSelectorRequirement core/v1)`] -| A list of scope selector requirements by scope of the resources. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../config_apis/infrastructure-config-openshift-io-v1.adoc#infrastructure-config-openshift-io-v1[`array (Infrastructure)`] +| List of infrastructures. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="seccompprofile-core-v1"] -== SeccompProfile [core/v1] +[id="io.openshift.config.v1.IngressList"] +== io.openshift.config.v1.IngressList schema Description:: + -- -SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +IngressList is a list of Ingress -- Type:: `object` Required:: - - `type` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `localhostProfile` +| `apiVersion` | `string` -| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `type` +| `items` +| xref:../config_apis/ingress-config-openshift-io-v1.adoc#ingress-config-openshift-io-v1[`array (Ingress)`] +| List of ingresses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| type indicates which kind of seccomp profile will be applied. Valid options are: +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretenvsource-core-v1"] -== SecretEnvSource [core/v1] +[id="io.openshift.config.v1.NetworkList"] +== io.openshift.config.v1.NetworkList schema Description:: + -- -SecretEnvSource selects a Secret to populate the environment variables with. - -The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +NetworkList is a list of Network -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `optional` -| `boolean` -| Specify whether the Secret must be defined +| `items` +| xref:../config_apis/network-config-openshift-io-v1.adoc#network-config-openshift-io-v1[`array (Network)`] +| List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretkeyselector-core-v1"] -== SecretKeySelector [core/v1] +[id="io.openshift.config.v1.OAuthList"] +== io.openshift.config.v1.OAuthList schema Description:: + -- -SecretKeySelector selects a key of a Secret. +OAuthList is a list of OAuth -- Type:: `object` Required:: - - `key` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `key` +| `apiVersion` | `string` -| The key of the secret to select from. Must be a valid secret key. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `name` +| `items` +| xref:../config_apis/oauth-config-openshift-io-v1.adoc#oauth-config-openshift-io-v1[`array (OAuth)`] +| List of oauths. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `optional` -| `boolean` -| Specify whether the Secret or its key must be defined +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretlist-core-v1"] -== SecretList [core/v1] +[id="io.openshift.config.v1.OperatorHubList"] +== io.openshift.config.v1.OperatorHubList schema Description:: + -- -SecretList is a list of Secret. +OperatorHubList is a list of OperatorHub -- Type:: @@ -12594,7 +7221,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12605,27 +7232,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../security_apis/secret-core-v1.adoc#secret-core-v1[`array (Secret core/v1)`] -| Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret +| xref:../config_apis/operatorhub-config-openshift-io-v1.adoc#operatorhub-config-openshift-io-v1[`array (OperatorHub)`] +| List of operatorhubs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretlist-image-openshift-io-v1"] -== SecretList [image.openshift.io/v1] +[id="io.openshift.config.v1.ProjectList"] +== io.openshift.config.v1.ProjectList schema Description:: + -- -SecretList is a list of Secret. +ProjectList is a list of Project -- Type:: @@ -12635,7 +7262,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12646,203 +7273,191 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../security_apis/secret-core-v1.adoc#secret-core-v1[`array (Secret core/v1)`] -| Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret +| xref:../config_apis/project-config-openshift-io-v1.adoc#project-config-openshift-io-v1[`array (Project)`] +| List of projects. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretprojection-core-v1"] -== SecretProjection [core/v1] +[id="io.openshift.config.v1.ProxyList"] +== io.openshift.config.v1.ProxyList schema Description:: + -- -Adapts a secret into a projected volume. - -The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. +ProxyList is a list of Proxy -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + | `items` -| xref:../objects/index.adoc#keytopath-core-v1[`array (KeyToPath core/v1)`] -| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +| xref:../config_apis/proxy-config-openshift-io-v1.adoc#proxy-config-openshift-io-v1[`array (Proxy)`] +| List of proxies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `name` +| `kind` | `string` -| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `optional` -| `boolean` -| Specify whether the Secret or its key must be defined +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretreference-core-v1"] -== SecretReference [core/v1] +[id="io.openshift.config.v1.SchedulerList"] +== io.openshift.config.v1.SchedulerList schema Description:: + -- -SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +SchedulerList is a list of Scheduler -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name is unique within a namespace to reference a secret resource. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `namespace` +| `items` +| xref:../config_apis/scheduler-config-openshift-io-v1.adoc#scheduler-config-openshift-io-v1[`array (Scheduler)`] +| List of schedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Namespace defines the space within which the secret name must be unique. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="secretvolumesource-core-v1"] -== SecretVolumeSource [core/v1] +[id="io.openshift.console.v1.ConsoleCLIDownloadList"] +== io.openshift.console.v1.ConsoleCLIDownloadList schema Description:: + -- -Adapts a Secret into a volume. - -The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. +ConsoleCLIDownloadList is a list of ConsoleCLIDownload -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `defaultMode` -| `integer` -| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../objects/index.adoc#keytopath-core-v1[`array (KeyToPath core/v1)`] -| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. - -| `optional` -| `boolean` -| Specify whether the Secret or its keys must be defined +| xref:../console_apis/consoleclidownload-console-openshift-io-v1.adoc#consoleclidownload-console-openshift-io-v1[`array (ConsoleCLIDownload)`] +| List of consoleclidownloads. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `secretName` +| `kind` | `string` -| Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="securitycontext-core-v1"] -== SecurityContext [core/v1] +[id="io.openshift.console.v1.ConsoleExternalLogLinkList"] +== io.openshift.console.v1.ConsoleExternalLogLinkList schema Description:: + -- -SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +ConsoleExternalLogLinkList is a list of ConsoleExternalLogLink -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `allowPrivilegeEscalation` -| `boolean` -| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN - -| `capabilities` -| xref:../objects/index.adoc#capabilities-core-v1[`Capabilities core/v1`] -| The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. - -| `privileged` -| `boolean` -| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. - -| `procMount` +| `apiVersion` | `string` -| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. - -| `readOnlyRootFilesystem` -| `boolean` -| Whether this container has a read-only root filesystem. Default is false. - -| `runAsGroup` -| `integer` -| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - -| `runAsNonRoot` -| `boolean` -| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. - -| `runAsUser` -| `integer` -| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `seLinuxOptions` -| xref:../objects/index.adoc#selinuxoptions-core-v1[`SELinuxOptions core/v1`] -| The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +| `items` +| xref:../console_apis/consoleexternalloglink-console-openshift-io-v1.adoc#consoleexternalloglink-console-openshift-io-v1[`array (ConsoleExternalLogLink)`] +| List of consoleexternalloglinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `seccompProfile` -| xref:../objects/index.adoc#seccompprofile-core-v1[`SeccompProfile core/v1`] -| The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `windowsOptions` -| xref:../objects/index.adoc#windowssecuritycontextoptions-core-v1[`WindowsSecurityContextOptions core/v1`] -| The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="securitycontextconstraintslist-security-openshift-io-v1"] -== SecurityContextConstraintsList [security.openshift.io/v1] +[id="io.openshift.console.v1.ConsoleLinkList"] +== io.openshift.console.v1.ConsoleLinkList schema Description:: + -- -SecurityContextConstraintsList is a list of SecurityContextConstraints +ConsoleLinkList is a list of ConsoleLink -- Type:: @@ -12852,7 +7467,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12863,66 +7478,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`array (SecurityContextConstraints security.openshift.io/v1)`] -| List of securitycontextconstraints. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../console_apis/consolelink-console-openshift-io-v1.adoc#consolelink-console-openshift-io-v1[`array (ConsoleLink)`] +| List of consolelinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="selinuxoptions-core-v1"] -== SELinuxOptions [core/v1] +[id="io.openshift.console.v1.ConsoleNotificationList"] +== io.openshift.console.v1.ConsoleNotificationList schema Description:: + -- -SELinuxOptions are the labels to be applied to the container +ConsoleNotificationList is a list of ConsoleNotification -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `level` +| `apiVersion` | `string` -| Level is SELinux level label that applies to the container. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `role` -| `string` -| Role is a SELinux role label that applies to the container. +| `items` +| xref:../console_apis/consolenotification-console-openshift-io-v1.adoc#consolenotification-console-openshift-io-v1[`array (ConsoleNotification)`] +| List of consolenotifications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `type` +| `kind` | `string` -| Type is a SELinux type label that applies to the container. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `user` -| `string` -| User is a SELinux user label that applies to the container. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="serviceaccountlist-core-v1"] -== ServiceAccountList [core/v1] +[id="io.openshift.console.v1.ConsoleQuickStartList"] +== io.openshift.console.v1.ConsoleQuickStartList schema Description:: + -- -ServiceAccountList is a list of ServiceAccount objects +ConsoleQuickStartList is a list of ConsoleQuickStart -- Type:: @@ -12932,7 +7549,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -12943,64 +7560,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../security_apis/serviceaccount-core-v1.adoc#serviceaccount-core-v1[`array (ServiceAccount core/v1)`] -| List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ +| xref:../console_apis/consolequickstart-console-openshift-io-v1.adoc#consolequickstart-console-openshift-io-v1[`array (ConsoleQuickStart)`] +| List of consolequickstarts. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="serviceaccounttokenprojection-core-v1"] -== ServiceAccountTokenProjection [core/v1] +[id="io.openshift.console.v1.ConsoleYAMLSampleList"] +== io.openshift.console.v1.ConsoleYAMLSampleList schema Description:: + -- -ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). +ConsoleYAMLSampleList is a list of ConsoleYAMLSample -- Type:: `object` Required:: - - `path` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `audience` +| `apiVersion` | `string` -| Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `expirationSeconds` -| `integer` -| ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. +| `items` +| xref:../console_apis/consoleyamlsample-console-openshift-io-v1.adoc#consoleyamlsample-console-openshift-io-v1[`array (ConsoleYAMLSample)`] +| List of consoleyamlsamples. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `path` +| `kind` | `string` -| Path is the path relative to the mount point of the file to project the token into. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="servicecalist-operator-openshift-io-v1"] -== ServiceCAList [operator.openshift.io/v1] +[id="io.openshift.console.v1alpha1.ConsolePluginList"] +== io.openshift.console.v1alpha1.ConsolePluginList schema Description:: + -- -ServiceCAList is a list of ServiceCA +ConsolePluginList is a list of ConsolePlugin -- Type:: @@ -13010,7 +7631,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13021,27 +7642,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`array (ServiceCA operator.openshift.io/v1)`] -| List of servicecas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc#consoleplugin-console-openshift-io-v1alpha1[`array (ConsolePlugin)`] +| List of consoleplugins. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="servicelist-core-v1"] -== ServiceList [core/v1] +[id="io.openshift.helm.v1beta1.HelmChartRepositoryList"] +== io.openshift.helm.v1beta1.HelmChartRepositoryList schema Description:: + -- -ServiceList holds a list of services. +HelmChartRepositoryList is a list of HelmChartRepository -- Type:: @@ -13051,7 +7672,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13062,27 +7683,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../network_apis/service-core-v1.adoc#service-core-v1[`array (Service core/v1)`] -| List of services +| xref:../config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc#helmchartrepository-helm-openshift-io-v1beta1[`array (HelmChartRepository)`] +| List of helmchartrepositories. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="servicemonitorlist-monitoring-coreos-com-v1"] -== ServiceMonitorList [monitoring.coreos.com/v1] +[id="io.openshift.machine.v1beta1.MachineHealthCheckList"] +== io.openshift.machine.v1beta1.MachineHealthCheckList schema Description:: + -- -ServiceMonitorList is a list of ServiceMonitor +MachineHealthCheckList is a list of MachineHealthCheck -- Type:: @@ -13092,7 +7713,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13103,103 +7724,109 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc#servicemonitor-monitoring-coreos-com-v1[`array (ServiceMonitor monitoring.coreos.com/v1)`] -| List of servicemonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc#machinehealthcheck-machine-openshift-io-v1beta1[`array (MachineHealthCheck)`] +| List of machinehealthchecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="serviceport-core-v1"] -== ServicePort [core/v1] +[id="io.openshift.machine.v1beta1.MachineList"] +== io.openshift.machine.v1beta1.MachineList schema Description:: + -- -ServicePort contains information on service's port. +MachineList is a list of Machine -- Type:: `object` Required:: - - `port` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `appProtocol` -| `string` -| The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. - -| `name` +| `apiVersion` | `string` -| The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. - -| `nodePort` -| `integer` -| The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `port` -| `integer` -| The port that will be exposed by this service. +| `items` +| xref:../machine_apis/machine-machine-openshift-io-v1beta1.adoc#machine-machine-openshift-io-v1beta1[`array (Machine)`] +| List of machines. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `protocol` +| `kind` | `string` -| The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `targetPort` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] -| Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="sessionaffinityconfig-core-v1"] -== SessionAffinityConfig [core/v1] +[id="io.openshift.machine.v1beta1.MachineSetList"] +== io.openshift.machine.v1beta1.MachineSetList schema Description:: + -- -SessionAffinityConfig represents the configurations of session affinity. +MachineSetList is a list of MachineSet -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `clientIP` -| xref:../objects/index.adoc#clientipconfig-core-v1[`ClientIPConfig core/v1`] -| clientIP contains the configurations of Client IP based session affinity. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../machine_apis/machineset-machine-openshift-io-v1beta1.adoc#machineset-machine-openshift-io-v1beta1[`array (MachineSet)`] +| List of machinesets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="statefulsetlist-apps-v1"] -== StatefulSetList [apps/v1] +[id="io.openshift.machineconfiguration.v1.ContainerRuntimeConfigList"] +== io.openshift.machineconfiguration.v1.ContainerRuntimeConfigList schema Description:: + -- -StatefulSetList is a collection of StatefulSets. +ContainerRuntimeConfigList is a list of ContainerRuntimeConfig -- Type:: @@ -13209,7 +7836,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13220,35 +7847,37 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`array (StatefulSet apps/v1)`] -| Items is the list of stateful sets. +| xref:../machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc#containerruntimeconfig-machineconfiguration-openshift-io-v1[`array (ContainerRuntimeConfig)`] +| List of containerruntimeconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="status-meta-v1"] -== Status [meta/v1] +[id="io.openshift.machineconfiguration.v1.ControllerConfigList"] +== io.openshift.machineconfiguration.v1.ControllerConfigList schema Description:: + -- -Status is a return value for calls that don't return other objects. +ControllerConfigList is a list of ControllerConfig -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13258,52 +7887,38 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `code` -| `integer` -| Suggested HTTP return code for this status, 0 if not set. - -| `details` -| xref:../objects/index.adoc#statusdetails-meta-v1[`StatusDetails meta/v1`] -| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +| `items` +| xref:../machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc#controllerconfig-machineconfiguration-openshift-io-v1[`array (ControllerConfig)`] +| List of controllerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` -| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - -| `message` -| `string` -| A human-readable description of the status of this operation. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `reason` -| `string` -| A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. - -| `status` -| `string` -| Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - |=== -[id="status_v2-meta-v1"] -== Status_v2 [meta/v1] +[id="io.openshift.machineconfiguration.v1.KubeletConfigList"] +== io.openshift.machineconfiguration.v1.KubeletConfigList schema Description:: + -- -Status is a return value for calls that don't return other objects. +KubeletConfigList is a list of KubeletConfig -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13313,130 +7928,110 @@ Type:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `code` -| `integer` -| Suggested HTTP return code for this status, 0 if not set. - -| `details` -| xref:../objects/index.adoc#statusdetails_v2-meta-v1[`StatusDetails_v2 meta/v1`] -| Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. +| `items` +| xref:../machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc#kubeletconfig-machineconfiguration-openshift-io-v1[`array (KubeletConfig)`] +| List of kubeletconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `message` -| `string` -| A human-readable description of the status of this operation. - | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `reason` -| `string` -| A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. - -| `status` -| `string` -| Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - |=== -[id="statuscause-meta-v1"] -== StatusCause [meta/v1] +[id="io.openshift.machineconfiguration.v1.MachineConfigList"] +== io.openshift.machineconfiguration.v1.MachineConfigList schema Description:: + -- -StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. +MachineConfigList is a list of MachineConfig -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `field` +| `apiVersion` | `string` -| The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -Examples: - "name" - the field "name" on the current resource - "items[0].name" - the field "name" on the first array entry in "items" +| `items` +| xref:../machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc#machineconfig-machineconfiguration-openshift-io-v1[`array (MachineConfig)`] +| List of machineconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `message` +| `kind` | `string` -| A human-readable description of the cause of the error. This field may be presented as-is to a reader. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `reason` -| `string` -| A machine-readable description of the cause of the error. If this value is empty there is no information available. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="statusdetails-meta-v1"] -== StatusDetails [meta/v1] +[id="io.openshift.machineconfiguration.v1.MachineConfigPoolList"] +== io.openshift.machineconfiguration.v1.MachineConfigPoolList schema Description:: + -- -StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. +MachineConfigPoolList is a list of MachineConfigPool -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `causes` -| xref:../objects/index.adoc#statuscause-meta-v1[`array (StatusCause meta/v1)`] -| The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. - -| `group` +| `apiVersion` | `string` -| The group attribute of the resource associated with the status StatusReason. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `kind` -| `string` -| The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +| `items` +| xref:../machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc#machineconfigpool-machineconfiguration-openshift-io-v1[`array (MachineConfigPool)`] +| List of machineconfigpools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `name` +| `kind` | `string` -| The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). - -| `retryAfterSeconds` -| `integer` -| If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `uid` -| `string` -| UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storageclasslist-storage-k8s-io-v1"] -== StorageClassList [storage.k8s.io/v1] +[id="io.openshift.network.v1.ClusterNetworkList"] +== io.openshift.network.v1.ClusterNetworkList schema Description:: + -- -StorageClassList is a collection of storage classes. +ClusterNetworkList is a list of ClusterNetwork -- Type:: @@ -13446,7 +8041,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13457,27 +8052,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`array (StorageClass storage.k8s.io/v1)`] -| Items is the list of StorageClasses +| xref:../network_apis/clusternetwork-network-openshift-io-v1.adoc#clusternetwork-network-openshift-io-v1[`array (ClusterNetwork)`] +| List of clusternetworks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storagelist-operator-openshift-io-v1"] -== StorageList [operator.openshift.io/v1] +[id="io.openshift.network.v1.EgressNetworkPolicyList"] +== io.openshift.network.v1.EgressNetworkPolicyList schema Description:: + -- -StorageList is a list of Storage +EgressNetworkPolicyList is a list of EgressNetworkPolicy -- Type:: @@ -13487,7 +8082,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13498,113 +8093,109 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`array (Storage operator.openshift.io/v1)`] -| List of storages. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc#egressnetworkpolicy-network-openshift-io-v1[`array (EgressNetworkPolicy)`] +| List of egressnetworkpolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storageospersistentvolumesource-core-v1"] -== StorageOSPersistentVolumeSource [core/v1] +[id="io.openshift.network.v1.HostSubnetList"] +== io.openshift.network.v1.HostSubnetList schema Description:: + -- -Represents a StorageOS persistent volume resource. +HostSubnetList is a list of HostSubnet -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretRef` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] -| SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. +| `items` +| xref:../network_apis/hostsubnet-network-openshift-io-v1.adoc#hostsubnet-network-openshift-io-v1[`array (HostSubnet)`] +| List of hostsubnets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `volumeName` +| `kind` | `string` -| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `volumeNamespace` -| `string` -| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storageosvolumesource-core-v1"] -== StorageOSVolumeSource [core/v1] +[id="io.openshift.network.v1.NetNamespaceList"] +== io.openshift.network.v1.NetNamespaceList schema Description:: + -- -Represents a StorageOS persistent volume resource. +NetNamespaceList is a list of NetNamespace -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - -| `readOnly` -| `boolean` -| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secretRef` -| xref:../objects/index.adoc#localobjectreference-core-v1[`LocalObjectReference core/v1`] -| SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. +| `items` +| xref:../network_apis/netnamespace-network-openshift-io-v1.adoc#netnamespace-network-openshift-io-v1[`array (NetNamespace)`] +| List of netnamespaces. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `volumeName` +| `kind` | `string` -| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `volumeNamespace` -| `string` -| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storagestatelist-migration-k8s-io-v1alpha1"] -== StorageStateList [migration.k8s.io/v1alpha1] +[id="io.openshift.operator.controlplane.v1alpha1.PodNetworkConnectivityCheckList"] +== io.openshift.operator.controlplane.v1alpha1.PodNetworkConnectivityCheckList schema Description:: + -- -StorageStateList is a list of StorageState +PodNetworkConnectivityCheckList is a list of PodNetworkConnectivityCheck -- Type:: @@ -13614,7 +8205,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13625,27 +8216,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`array (StorageState migration.k8s.io/v1alpha1)`] -| List of storagestates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc#podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1[`array (PodNetworkConnectivityCheck)`] +| List of podnetworkconnectivitychecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="storageversionmigrationlist-migration-k8s-io-v1alpha1"] -== StorageVersionMigrationList [migration.k8s.io/v1alpha1] +[id="io.openshift.operator.imageregistry.v1.ConfigList"] +== io.openshift.operator.imageregistry.v1.ConfigList schema Description:: + -- -StorageVersionMigrationList is a list of StorageVersionMigration +ConfigList is a list of Config -- Type:: @@ -13655,7 +8246,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13666,27 +8257,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`array (StorageVersionMigration migration.k8s.io/v1alpha1)`] -| List of storageversionmigrations. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`array (Config)`] +| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="subscriptionlist-operators-coreos-com-v1alpha1"] -== SubscriptionList [operators.coreos.com/v1alpha1] +[id="io.openshift.operator.imageregistry.v1.ImagePrunerList"] +== io.openshift.operator.imageregistry.v1.ImagePrunerList schema Description:: + -- -SubscriptionList is a list of Subscription +ImagePrunerList is a list of ImagePruner -- Type:: @@ -13696,7 +8287,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13707,136 +8298,150 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`array (Subscription operators.coreos.com/v1alpha1)`] -| List of subscriptions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`array (ImagePruner)`] +| List of imagepruners. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="sysctl-core-v1"] -== Sysctl [core/v1] +[id="io.openshift.operator.ingress.v1.DNSRecordList"] +== io.openshift.operator.ingress.v1.DNSRecordList schema Description:: + -- -Sysctl defines a kernel parameter to be set +DNSRecordList is a list of DNSRecord -- Type:: `object` Required:: - - `name` - - `value` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `name` +| `apiVersion` | `string` -| Name of a property to set +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `value` +| `items` +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`array (DNSRecord)`] +| List of dnsrecords. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Value of a property to set +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="taint-core-v1"] -== Taint [core/v1] +[id="io.openshift.operator.network.v1.EgressRouterList"] +== io.openshift.operator.network.v1.EgressRouterList schema Description:: + -- -The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. +EgressRouterList is a list of EgressRouter -- Type:: `object` Required:: - - `key` - - `effect` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `effect` -| `string` -| Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. - -| `key` +| `apiVersion` | `string` -| Required. The taint key to be applied to a node. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `timeAdded` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] -| TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. +| `items` +| xref:../network_apis/egressrouter-network-operator-openshift-io-v1.adoc#egressrouter-network-operator-openshift-io-v1[`array (EgressRouter)`] +| List of egressrouters. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `value` +| `kind` | `string` -| The taint value corresponding to the taint key. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="tcpsocketaction-core-v1"] -== TCPSocketAction [core/v1] +[id="io.openshift.operator.network.v1.OperatorPKIList"] +== io.openshift.operator.network.v1.OperatorPKIList schema Description:: + -- -TCPSocketAction describes an action based on opening a socket +OperatorPKIList is a list of OperatorPKI -- Type:: `object` Required:: - - `port` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `host` +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`array (OperatorPKI)`] +| List of operatorpkis. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| Optional: Host name to connect to, defaults to the pod IP. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `port` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] -| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="templateinstancelist-template-openshift-io-v1"] -== TemplateInstanceList [template.openshift.io/v1] +[id="io.openshift.operator.samples.v1.ConfigList"] +== io.openshift.operator.samples.v1.ConfigList schema Description:: + -- -TemplateInstanceList is a list of TemplateInstance objects. +ConfigList is a list of Config -- Type:: @@ -13846,7 +8451,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13857,27 +8462,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`array (TemplateInstance template.openshift.io/v1)`] -| items is a list of Templateinstances +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`array (Config)`] +| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="thanosrulerlist-monitoring-coreos-com-v1"] -== ThanosRulerList [monitoring.coreos.com/v1] +[id="io.openshift.operator.v1.AuthenticationList"] +== io.openshift.operator.v1.AuthenticationList schema Description:: + -- -ThanosRulerList is a list of ThanosRuler +AuthenticationList is a list of Authentication -- Type:: @@ -13887,7 +8492,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13898,52 +8503,37 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`array (ThanosRuler monitoring.coreos.com/v1)`] -| List of thanosrulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`array (Authentication)`] +| List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="time-meta-v1"] -== Time [meta/v1] +[id="io.openshift.operator.v1.CloudCredentialList"] +== io.openshift.operator.v1.CloudCredentialList schema Description:: + -- -Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. --- - -Type:: - `string` - - - -[id="tokenrequest-authentication-k8s-io-v1"] -== TokenRequest [authentication.k8s.io/v1] - - -Description:: -+ --- -TokenRequest requests a token for a given service account. +CloudCredentialList is a list of CloudCredential -- Type:: `object` Required:: - - `spec` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -13953,182 +8543,192 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `items` +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`array (CloudCredential)`] +| List of cloudcredentials. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `spec` -| xref:../objects/index.adoc#tokenrequestspec-authentication-k8s-io-v1[`TokenRequestSpec authentication.k8s.io/v1`] -| Spec holds information about the request being evaluated - -| `status` -| xref:../objects/index.adoc#tokenrequeststatus-authentication-k8s-io-v1[`TokenRequestStatus authentication.k8s.io/v1`] -| Status is filled in by the server and indicates whether the token can be authenticated. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="toleration-core-v1"] -== Toleration [core/v1] +[id="io.openshift.operator.v1.ClusterCSIDriverList"] +== io.openshift.operator.v1.ClusterCSIDriverList schema Description:: + -- -The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . +ClusterCSIDriverList is a list of ClusterCSIDriver -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `effect` +| `apiVersion` | `string` -| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `key` -| `string` -| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. +| `items` +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`array (ClusterCSIDriver)`] +| List of clustercsidrivers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `operator` +| `kind` | `string` -| Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. - -| `tolerationSeconds` -| `integer` -| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `value` -| `string` -| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="topologyselectorlabelrequirement-core-v1"] -== TopologySelectorLabelRequirement [core/v1] +[id="io.openshift.operator.v1.ConfigList"] +== io.openshift.operator.v1.ConfigList schema Description:: + -- -A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. +ConfigList is a list of Config -- Type:: `object` Required:: - - `key` - - `values` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `key` +| `apiVersion` | `string` -| The label key that the selector applies to. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `values` -| `array (string)` -| An array of string values. One value must match the label to be selected. Each entry in Values is ORed. +| `items` +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`array (Config)`] +| List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="topologyselectorterm-core-v1"] -== TopologySelectorTerm [core/v1] +[id="io.openshift.operator.v1.ConsoleList"] +== io.openshift.operator.v1.ConsoleList schema Description:: + -- -A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. +ConsoleList is a list of Console -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `matchLabelExpressions` -| xref:../objects/index.adoc#topologyselectorlabelrequirement-core-v1[`array (TopologySelectorLabelRequirement core/v1)`] -| A list of topology selector requirements by labels. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`array (Console)`] +| List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="topologyspreadconstraint-core-v1"] -== TopologySpreadConstraint [core/v1] +[id="io.openshift.operator.v1.CSISnapshotControllerList"] +== io.openshift.operator.v1.CSISnapshotControllerList schema Description:: + -- -TopologySpreadConstraint specifies how to spread matching pods among the given topology. +CSISnapshotControllerList is a list of CSISnapshotController -- Type:: `object` Required:: - - `maxSkew` - - `topologyKey` - - `whenUnsatisfiable` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `labelSelector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] -| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `maxSkew` -| `integer` -| MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: \| zone1 \| zone2 \| zone3 \| \| P \| P \| \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. +| `items` +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`array (CSISnapshotController)`] +| List of csisnapshotcontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `topologyKey` +| `kind` | `string` -| TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `whenUnsatisfiable` -| `string` -| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, - but giving higher precedence to topologies that would help reduce the - skew. -A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="tunedlist-tuned-openshift-io-v1"] -== TunedList [tuned.openshift.io/v1] +[id="io.openshift.operator.v1.DNSList"] +== io.openshift.operator.v1.DNSList schema Description:: + -- -TunedList is a list of Tuned +DNSList is a list of DNS -- Type:: @@ -14138,7 +8738,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14149,65 +8749,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`array (Tuned tuned.openshift.io/v1)`] -| List of tuneds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`array (DNS)`] +| List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="typedlocalobjectreference-core-v1"] -== TypedLocalObjectReference [core/v1] +[id="io.openshift.operator.v1.EtcdList"] +== io.openshift.operator.v1.EtcdList schema Description:: + -- -TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +EtcdList is a list of Etcd -- Type:: `object` Required:: - - `kind` - - `name` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `apiGroup` +| `apiVersion` | `string` -| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`array (Etcd)`] +| List of etcds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` -| Kind is the type of resource being referenced +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `name` -| `string` -| Name is the name of resource being referenced +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="userlist-user-openshift-io-v1"] -== UserList [user.openshift.io/v1] +[id="io.openshift.operator.v1.IngressControllerList"] +== io.openshift.operator.v1.IngressControllerList schema Description:: + -- -UserList is a collection of Users +IngressControllerList is a list of IngressController -- Type:: @@ -14217,7 +8820,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14228,27 +8831,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`array (User user.openshift.io/v1)`] -| Items is the list of users +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`array (IngressController)`] +| List of ingresscontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="useroauthaccesstokenlist-oauth-openshift-io-v1"] -== UserOAuthAccessTokenList [oauth.openshift.io/v1] +[id="io.openshift.operator.v1.KubeAPIServerList"] +== io.openshift.operator.v1.KubeAPIServerList schema Description:: + -- -UserOAuthAccessTokenList is a collection of access tokens issued on behalf of the requesting user +KubeAPIServerList is a list of KubeAPIServer -- Type:: @@ -14258,7 +8861,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14269,27 +8872,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc#useroauthaccesstoken-oauth-openshift-io-v1[`array (UserOAuthAccessToken oauth.openshift.io/v1)`] -| +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`array (KubeAPIServer)`] +| List of kubeapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="validatingwebhookconfigurationlist-admissionregistration-k8s-io-v1"] -== ValidatingWebhookConfigurationList [admissionregistration.k8s.io/v1] +[id="io.openshift.operator.v1.KubeControllerManagerList"] +== io.openshift.operator.v1.KubeControllerManagerList schema Description:: + -- -ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. +KubeControllerManagerList is a list of KubeControllerManager -- Type:: @@ -14299,7 +8902,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14310,187 +8913,68 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc#validatingwebhookconfiguration-admissionregistration-k8s-io-v1[`array (ValidatingWebhookConfiguration admissionregistration.k8s.io/v1)`] -| List of ValidatingWebhookConfiguration. +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`array (KubeControllerManager)`] +| List of kubecontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volume-core-v1"] -== Volume [core/v1] +[id="io.openshift.operator.v1.KubeSchedulerList"] +== io.openshift.operator.v1.KubeSchedulerList schema Description:: + -- -Volume represents a named volume in a pod that may be accessed by any container in the pod. +KubeSchedulerList is a list of KubeScheduler -- Type:: `object` Required:: - - `name` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `awsElasticBlockStore` -| xref:../objects/index.adoc#awselasticblockstorevolumesource-core-v1[`AWSElasticBlockStoreVolumeSource core/v1`] -| AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - -| `azureDisk` -| xref:../objects/index.adoc#azurediskvolumesource-core-v1[`AzureDiskVolumeSource core/v1`] -| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - -| `azureFile` -| xref:../objects/index.adoc#azurefilevolumesource-core-v1[`AzureFileVolumeSource core/v1`] -| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - -| `cephfs` -| xref:../objects/index.adoc#cephfsvolumesource-core-v1[`CephFSVolumeSource core/v1`] -| CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - -| `cinder` -| xref:../objects/index.adoc#cindervolumesource-core-v1[`CinderVolumeSource core/v1`] -| Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md - -| `configMap` -| xref:../objects/index.adoc#configmapvolumesource-core-v1[`ConfigMapVolumeSource core/v1`] -| ConfigMap represents a configMap that should populate this volume - -| `csi` -| xref:../objects/index.adoc#csivolumesource-core-v1[`CSIVolumeSource core/v1`] -| CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). - -| `downwardAPI` -| xref:../objects/index.adoc#downwardapivolumesource-core-v1[`DownwardAPIVolumeSource core/v1`] -| DownwardAPI represents downward API about the pod that should populate this volume - -| `emptyDir` -| xref:../objects/index.adoc#emptydirvolumesource-core-v1[`EmptyDirVolumeSource core/v1`] -| EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - -| `ephemeral` -| xref:../objects/index.adoc#ephemeralvolumesource-core-v1[`EphemeralVolumeSource core/v1`] -| Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. - -Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity - tracking are needed, -c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through - a PersistentVolumeClaim (see EphemeralVolumeSource for more - information on the connection between this volume type - and PersistentVolumeClaim). - -Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. - -Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. - -A pod can use both types of ephemeral volumes and persistent volumes at the same time. - -This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled. - -| `fc` -| xref:../objects/index.adoc#fcvolumesource-core-v1[`FCVolumeSource core/v1`] -| FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - -| `flexVolume` -| xref:../objects/index.adoc#flexvolumesource-core-v1[`FlexVolumeSource core/v1`] -| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. - -| `flocker` -| xref:../objects/index.adoc#flockervolumesource-core-v1[`FlockerVolumeSource core/v1`] -| Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - -| `gcePersistentDisk` -| xref:../objects/index.adoc#gcepersistentdiskvolumesource-core-v1[`GCEPersistentDiskVolumeSource core/v1`] -| GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - -| `gitRepo` -| xref:../objects/index.adoc#gitrepovolumesource-core-v1[`GitRepoVolumeSource core/v1`] -| GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. - -| `glusterfs` -| xref:../objects/index.adoc#glusterfsvolumesource-core-v1[`GlusterfsVolumeSource core/v1`] -| Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md - -| `hostPath` -| xref:../objects/index.adoc#hostpathvolumesource-core-v1[`HostPathVolumeSource core/v1`] -| HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - -| `iscsi` -| xref:../objects/index.adoc#iscsivolumesource-core-v1[`ISCSIVolumeSource core/v1`] -| ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md - -| `name` +| `apiVersion` | `string` -| Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - -| `nfs` -| xref:../objects/index.adoc#nfsvolumesource-core-v1[`NFSVolumeSource core/v1`] -| NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - -| `persistentVolumeClaim` -| xref:../objects/index.adoc#persistentvolumeclaimvolumesource-core-v1[`PersistentVolumeClaimVolumeSource core/v1`] -| PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - -| `photonPersistentDisk` -| xref:../objects/index.adoc#photonpersistentdiskvolumesource-core-v1[`PhotonPersistentDiskVolumeSource core/v1`] -| PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - -| `portworxVolume` -| xref:../objects/index.adoc#portworxvolumesource-core-v1[`PortworxVolumeSource core/v1`] -| PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - -| `projected` -| xref:../objects/index.adoc#projectedvolumesource-core-v1[`ProjectedVolumeSource core/v1`] -| Items for all in one resources secrets, configmaps, and downward API - -| `quobyte` -| xref:../objects/index.adoc#quobytevolumesource-core-v1[`QuobyteVolumeSource core/v1`] -| Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - -| `rbd` -| xref:../objects/index.adoc#rbdvolumesource-core-v1[`RBDVolumeSource core/v1`] -| RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md - -| `scaleIO` -| xref:../objects/index.adoc#scaleiovolumesource-core-v1[`ScaleIOVolumeSource core/v1`] -| ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `secret` -| xref:../objects/index.adoc#secretvolumesource-core-v1[`SecretVolumeSource core/v1`] -| Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +| `items` +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`array (KubeScheduler)`] +| List of kubeschedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `storageos` -| xref:../objects/index.adoc#storageosvolumesource-core-v1[`StorageOSVolumeSource core/v1`] -| StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `vsphereVolume` -| xref:../objects/index.adoc#vspherevirtualdiskvolumesource-core-v1[`VsphereVirtualDiskVolumeSource core/v1`] -| VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumeattachmentlist-storage-k8s-io-v1"] -== VolumeAttachmentList [storage.k8s.io/v1] +[id="io.openshift.operator.v1.KubeStorageVersionMigratorList"] +== io.openshift.operator.v1.KubeStorageVersionMigratorList schema Description:: + -- -VolumeAttachmentList is a collection of VolumeAttachment objects. +KubeStorageVersionMigratorList is a list of KubeStorageVersionMigrator -- Type:: @@ -14500,7 +8984,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14511,177 +8995,191 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`array (VolumeAttachment storage.k8s.io/v1)`] -| Items is the list of VolumeAttachments +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`array (KubeStorageVersionMigrator)`] +| List of kubestorageversionmigrators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] -| Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumedevice-core-v1"] -== VolumeDevice [core/v1] +[id="io.openshift.operator.v1.NetworkList"] +== io.openshift.operator.v1.NetworkList schema Description:: + -- -volumeDevice describes a mapping of a raw block device within a container. +NetworkList is a list of Network -- Type:: `object` Required:: - - `name` - - `devicePath` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `devicePath` +| `apiVersion` | `string` -| devicePath is the path inside of the container that the device will be mapped to. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `name` +| `items` +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`array (Network)`] +| List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` | `string` -| name must match the name of a persistentVolumeClaim in the pod +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumemount-core-v1"] -== VolumeMount [core/v1] +[id="io.openshift.operator.v1.OpenShiftAPIServerList"] +== io.openshift.operator.v1.OpenShiftAPIServerList schema Description:: + -- -VolumeMount describes a mounting of a Volume within a container. +OpenShiftAPIServerList is a list of OpenShiftAPIServer -- Type:: `object` Required:: - - `name` - - `mountPath` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `mountPath` -| `string` -| Path within the container at which the volume should be mounted. Must not contain ':'. - -| `mountPropagation` -| `string` -| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. - -| `name` +| `apiVersion` | `string` -| This must match the Name of a Volume. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `readOnly` -| `boolean` -| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +| `items` +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`array (OpenShiftAPIServer)`] +| List of openshiftapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `subPath` +| `kind` | `string` -| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `subPathExpr` -| `string` -| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumenodeaffinity-core-v1"] -== VolumeNodeAffinity [core/v1] +[id="io.openshift.operator.v1.OpenShiftControllerManagerList"] +== io.openshift.operator.v1.OpenShiftControllerManagerList schema Description:: + -- -VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. +OpenShiftControllerManagerList is a list of OpenShiftControllerManager -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `required` -| xref:../objects/index.adoc#nodeselector-core-v1[`NodeSelector core/v1`] -| Required specifies hard node constraints that must be met. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `items` +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`array (OpenShiftControllerManager)`] +| List of openshiftcontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumeprojection-core-v1"] -== VolumeProjection [core/v1] +[id="io.openshift.operator.v1.ServiceCAList"] +== io.openshift.operator.v1.ServiceCAList schema Description:: + -- -Projection that may be projected along with other supported volume types +ServiceCAList is a list of ServiceCA -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `configMap` -| xref:../objects/index.adoc#configmapprojection-core-v1[`ConfigMapProjection core/v1`] -| information about the configMap data to project +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `downwardAPI` -| xref:../objects/index.adoc#downwardapiprojection-core-v1[`DownwardAPIProjection core/v1`] -| information about the downwardAPI data to project +| `items` +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`array (ServiceCA)`] +| List of servicecas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `secret` -| xref:../objects/index.adoc#secretprojection-core-v1[`SecretProjection core/v1`] -| information about the secret data to project +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `serviceAccountToken` -| xref:../objects/index.adoc#serviceaccounttokenprojection-core-v1[`ServiceAccountTokenProjection core/v1`] -| information about the serviceAccountToken data to project +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumesnapshotclasslist-snapshot-storage-k8s-io-v1"] -== VolumeSnapshotClassList [snapshot.storage.k8s.io/v1] +[id="io.openshift.operator.v1.StorageList"] +== io.openshift.operator.v1.StorageList schema Description:: + -- -VolumeSnapshotClassList is a list of VolumeSnapshotClass +StorageList is a list of Storage -- Type:: @@ -14691,7 +9189,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14702,27 +9200,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`array (VolumeSnapshotClass snapshot.storage.k8s.io/v1)`] -| List of volumesnapshotclasses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`array (Storage)`] +| List of storages. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumesnapshotcontentlist-snapshot-storage-k8s-io-v1"] -== VolumeSnapshotContentList [snapshot.storage.k8s.io/v1] +[id="io.openshift.operator.v1alpha1.ImageContentSourcePolicyList"] +== io.openshift.operator.v1alpha1.ImageContentSourcePolicyList schema Description:: + -- -VolumeSnapshotContentList is a list of VolumeSnapshotContent +ImageContentSourcePolicyList is a list of ImageContentSourcePolicy -- Type:: @@ -14732,7 +9230,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14743,27 +9241,27 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`array (VolumeSnapshotContent snapshot.storage.k8s.io/v1)`] -| List of volumesnapshotcontents. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`array (ImageContentSourcePolicy)`] +| List of imagecontentsourcepolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="volumesnapshotlist-snapshot-storage-k8s-io-v1"] -== VolumeSnapshotList [snapshot.storage.k8s.io/v1] +[id="io.openshift.quota.v1.ClusterResourceQuotaList"] +== io.openshift.quota.v1.ClusterResourceQuotaList schema Description:: + -- -VolumeSnapshotList is a list of VolumeSnapshot +ClusterResourceQuotaList is a list of ClusterResourceQuota -- Type:: @@ -14773,7 +9271,7 @@ Required:: - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== @@ -14784,130 +9282,139 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `items` -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`array (VolumeSnapshot snapshot.storage.k8s.io/v1)`] -| List of volumesnapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`array (ClusterResourceQuota)`] +| List of clusterresourcequotas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#listmeta-meta-v1[`ListMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="vspherevirtualdiskvolumesource-core-v1"] -== VsphereVirtualDiskVolumeSource [core/v1] +[id="io.openshift.security.v1.SecurityContextConstraintsList"] +== io.openshift.security.v1.SecurityContextConstraintsList schema Description:: + -- -Represents a vSphere volume resource. +SecurityContextConstraintsList is a list of SecurityContextConstraints -- Type:: `object` Required:: - - `volumePath` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `fsType` +| `apiVersion` | `string` -| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `storagePolicyID` -| `string` -| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +| `items` +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`array (SecurityContextConstraints)`] +| List of securitycontextconstraints. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `storagePolicyName` +| `kind` | `string` -| Storage Policy Based Management (SPBM) profile name. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -| `volumePath` -| `string` -| Path that identifies vSphere volume vmdk +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="weightedpodaffinityterm-core-v1"] -== WeightedPodAffinityTerm [core/v1] +[id="io.openshift.tuned.v1.ProfileList"] +== io.openshift.tuned.v1.ProfileList schema Description:: + -- -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +ProfileList is a list of Profile -- Type:: `object` Required:: - - `weight` - - `podAffinityTerm` + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `podAffinityTerm` -| xref:../objects/index.adoc#podaffinityterm-core-v1[`PodAffinityTerm core/v1`] -| Required. A pod affinity term, associated with the corresponding weight. +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `weight` -| `integer` -| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. +| `items` +| xref:../node_apis/profile-tuned-openshift-io-v1.adoc#profile-tuned-openshift-io-v1[`array (Profile)`] +| List of profiles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== -[id="windowssecuritycontextoptions-core-v1"] -== WindowsSecurityContextOptions [core/v1] +[id="io.openshift.tuned.v1.TunedList"] +== io.openshift.tuned.v1.TunedList schema Description:: + -- -WindowsSecurityContextOptions contain Windows-specific options and credentials. +TunedList is a list of Tuned -- Type:: `object` +Required:: + - `items` [discrete] -=== Specification +=== Schema [cols="1,1,1",options="header"] |=== | Property | Type | Description -| `gmsaCredentialSpec` -| `string` -| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. - -| `gmsaCredentialSpecName` +| `apiVersion` | `string` -| GMSACredentialSpecName is the name of the GMSA credential spec to use. +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -| `hostProcess` -| `boolean` -| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +| `items` +| xref:../node_apis/tuned-tuned-openshift-io-v1.adoc#tuned-tuned-openshift-io-v1[`array (Tuned)`] +| List of tuneds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md -| `runAsUserName` +| `kind` | `string` -| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta[`ListMeta`] +| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |=== diff --git a/rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc b/rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc index 06c194afd977..cded59757a4d 100644 --- a/rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="authentication-operator-openshift-io-v1"] = Authentication [operator.openshift.io/v1] ifdef::product-title[] @@ -10,7 +12,8 @@ toc::[] Description:: + -- -Authentication provides information to configure an operator to manage authentication. +Authentication provides information to configure an operator to manage authentication. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -35,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -87,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -137,7 +140,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -150,7 +153,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -188,7 +191,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -201,7 +204,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -243,7 +246,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.oauthAPIServer +=== .status.oauthAPIServer Description:: + -- @@ -351,7 +354,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -408,7 +413,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#authenticationlist-operator-openshift-io-v1[`AuthenticationList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.AuthenticationList[`AuthenticationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -435,7 +442,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema | |=== @@ -444,7 +451,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 202 - Accepted +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== @@ -498,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -507,7 +520,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -534,7 +551,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -561,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -570,7 +589,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -597,7 +618,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema | |=== @@ -606,7 +627,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== @@ -654,7 +679,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -681,7 +708,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -690,7 +717,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -717,7 +746,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema | |=== @@ -726,7 +755,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication operator.openshift.io/v1`] +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 201 - Created +| xref:../operator_apis/authentication-operator-openshift-io-v1.adoc#authentication-operator-openshift-io-v1[`Authentication`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc b/rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc index 4d86d4fb4394..b0ad0410e889 100644 --- a/rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="cloudcredential-operator-openshift-io-v1"] = CloudCredential [operator.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | CloudCredentialStatus defines the observed status of the cloud-credential-operator. |=== -..spec +=== .spec Description:: + -- @@ -91,7 +93,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -137,7 +139,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -150,7 +152,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -188,7 +190,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -201,7 +203,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -329,7 +331,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -386,7 +390,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#cloudcredentiallist-operator-openshift-io-v1[`CloudCredentialList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.CloudCredentialList[`CloudCredentialList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -413,7 +419,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema | |=== @@ -422,7 +428,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 201 - Created +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 202 - Accepted +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== @@ -476,7 +488,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -485,7 +497,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -512,7 +528,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +557,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -548,7 +566,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -575,7 +595,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema | |=== @@ -584,7 +604,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 201 - Created +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== @@ -632,7 +656,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -659,7 +685,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -668,7 +694,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -695,7 +723,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema | |=== @@ -704,7 +732,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential operator.openshift.io/v1`] +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 201 - Created +| xref:../operator_apis/cloudcredential-operator-openshift-io-v1.adoc#cloudcredential-operator-openshift-io-v1[`CloudCredential`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc b/rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc index 79df365b90b0..1f779a886d96 100644 --- a/rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clustercsidriver-operator-openshift-io-v1"] = ClusterCSIDriver [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clustercsidriverlist-operator-openshift-io-v1[`ClusterCSIDriverList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.ClusterCSIDriverList[`ClusterCSIDriverList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 201 - Created +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 202 - Accepted +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 201 - Created +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver operator.openshift.io/v1`] +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 201 - Created +| xref:../operator_apis/clustercsidriver-operator-openshift-io-v1.adoc#clustercsidriver-operator-openshift-io-v1[`ClusterCSIDriver`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc b/rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc index dee15d082159..9af96fabea35 100644 --- a/rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="config-imageregistry-operator-openshift-io-v1"] = Config [imageregistry.operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | ImageRegistryStatus reports image registry operational status. |=== -..spec +=== .spec Description:: + -- @@ -159,7 +161,7 @@ Required:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..spec.affinity +=== .spec.affinity Description:: + -- @@ -189,7 +191,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.affinity.nodeAffinity +=== .spec.affinity.nodeAffinity Description:: + -- @@ -219,7 +221,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -232,7 +234,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -261,7 +263,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -295,7 +297,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -308,7 +310,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -341,7 +343,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -354,7 +356,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -387,7 +389,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -415,7 +417,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -428,7 +430,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -462,7 +464,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -475,7 +477,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -508,7 +510,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -521,7 +523,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -554,7 +556,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity +=== .spec.affinity.podAffinity Description:: + -- @@ -588,7 +590,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -601,7 +603,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -630,7 +632,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -666,7 +668,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -696,7 +698,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -709,7 +711,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -742,7 +744,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -772,7 +774,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -785,7 +787,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -818,7 +820,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -831,7 +833,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -867,7 +869,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -897,7 +899,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -910,7 +912,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -943,7 +945,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -973,7 +975,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -986,7 +988,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -1019,7 +1021,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity +=== .spec.affinity.podAntiAffinity Description:: + -- @@ -1053,7 +1055,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1066,7 +1068,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1095,7 +1097,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -1131,7 +1133,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1161,7 +1163,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1174,7 +1176,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1207,7 +1209,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -1237,7 +1239,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -1250,7 +1252,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -1283,7 +1285,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1296,7 +1298,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1332,7 +1334,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1362,7 +1364,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1375,7 +1377,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1408,7 +1410,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -1438,7 +1440,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -1451,7 +1453,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -1484,7 +1486,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.proxy +=== .spec.proxy Description:: + -- @@ -1514,7 +1516,7 @@ Type:: | noProxy defines a comma-separated list of host names that shouldn't go through any proxy. |=== -..spec.requests +=== .spec.requests Description:: + -- @@ -1540,7 +1542,7 @@ Type:: | write defines limits for image registry's writes. |=== -..spec.requests.read +=== .spec.requests.read Description:: + -- @@ -1570,7 +1572,7 @@ Type:: | maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |=== -..spec.requests.write +=== .spec.requests.write Description:: + -- @@ -1600,7 +1602,7 @@ Type:: | maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |=== -..spec.resources +=== .spec.resources Description:: + -- @@ -1626,7 +1628,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.routes +=== .spec.routes Description:: + -- @@ -1639,7 +1641,7 @@ Type:: -..spec.routes[] +=== .spec.routes[] Description:: + -- @@ -1671,7 +1673,7 @@ Required:: | secretName points to secret containing the certificates to be used by the route. |=== -..spec.storage +=== .spec.storage Description:: + -- @@ -1721,7 +1723,7 @@ Type:: | swift represents configuration that uses OpenStack Object Storage. |=== -..spec.storage.azure +=== .spec.storage.azure Description:: + -- @@ -1751,7 +1753,7 @@ Type:: | container defines Azure's container to be used by registry. |=== -..spec.storage.emptyDir +=== .spec.storage.emptyDir Description:: + -- @@ -1764,7 +1766,7 @@ Type:: -..spec.storage.gcs +=== .spec.storage.gcs Description:: + -- @@ -1798,7 +1800,7 @@ Type:: | region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |=== -..spec.storage.ibmcos +=== .spec.storage.ibmcos Description:: + -- @@ -1836,7 +1838,7 @@ Type:: | serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. |=== -..spec.storage.pvc +=== .spec.storage.pvc Description:: + -- @@ -1858,7 +1860,7 @@ Type:: | claim defines the Persisent Volume Claim's name to be used. |=== -..spec.storage.s3 +=== .spec.storage.s3 Description:: + -- @@ -1904,7 +1906,7 @@ Type:: | virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. |=== -..spec.storage.s3.cloudFront +=== .spec.storage.s3.cloudFront Description:: + -- @@ -1942,7 +1944,7 @@ Required:: | privateKey points to secret containing the private key, provided by AWS. |=== -..spec.storage.s3.cloudFront.privateKey +=== .spec.storage.s3.cloudFront.privateKey Description:: + -- @@ -1974,7 +1976,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.storage.swift +=== .spec.storage.swift Description:: + -- @@ -2024,7 +2026,7 @@ Type:: | tenant defines Openstack tenant id to be used by registry. |=== -..spec.tolerations +=== .spec.tolerations Description:: + -- @@ -2037,7 +2039,7 @@ Type:: -..spec.tolerations[] +=== .spec.tolerations[] Description:: + -- @@ -2075,7 +2077,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..status +=== .status Description:: + -- @@ -2132,7 +2134,7 @@ Required:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -2145,7 +2147,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -2183,7 +2185,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -2196,7 +2198,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -2238,7 +2240,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.storage +=== .status.storage Description:: + -- @@ -2288,7 +2290,7 @@ Type:: | swift represents configuration that uses OpenStack Object Storage. |=== -..status.storage.azure +=== .status.storage.azure Description:: + -- @@ -2318,7 +2320,7 @@ Type:: | container defines Azure's container to be used by registry. |=== -..status.storage.emptyDir +=== .status.storage.emptyDir Description:: + -- @@ -2331,7 +2333,7 @@ Type:: -..status.storage.gcs +=== .status.storage.gcs Description:: + -- @@ -2365,7 +2367,7 @@ Type:: | region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |=== -..status.storage.ibmcos +=== .status.storage.ibmcos Description:: + -- @@ -2403,7 +2405,7 @@ Type:: | serviceInstanceCRN is the CRN of the IBM Cloud Object Storage service instance that this bucket is associated with. Optional, will be computed if not provided. |=== -..status.storage.pvc +=== .status.storage.pvc Description:: + -- @@ -2425,7 +2427,7 @@ Type:: | claim defines the Persisent Volume Claim's name to be used. |=== -..status.storage.s3 +=== .status.storage.s3 Description:: + -- @@ -2471,7 +2473,7 @@ Type:: | virtualHostedStyle enables using S3 virtual hosted style bucket paths with a custom RegionEndpoint Optional, defaults to false. |=== -..status.storage.s3.cloudFront +=== .status.storage.s3.cloudFront Description:: + -- @@ -2509,7 +2511,7 @@ Required:: | privateKey points to secret containing the private key, provided by AWS. |=== -..status.storage.s3.cloudFront.privateKey +=== .status.storage.s3.cloudFront.privateKey Description:: + -- @@ -2541,7 +2543,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..status.storage.swift +=== .status.storage.swift Description:: + -- @@ -2677,7 +2679,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2734,7 +2738,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#configlist-imageregistry-operator-openshift-io-v1[`ConfigList imageregistry.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.imageregistry.v1.ConfigList[`ConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2761,7 +2767,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema | |=== @@ -2770,7 +2776,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 202 - Accepted +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -2824,7 +2836,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -2833,7 +2845,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2860,7 +2876,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2887,7 +2905,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2896,7 +2914,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2923,7 +2943,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema | |=== @@ -2932,7 +2952,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -2980,7 +3004,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3007,7 +3033,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -3016,7 +3042,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3043,7 +3071,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema | |=== @@ -3052,7 +3080,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-imageregistry-operator-openshift-io-v1.adoc#config-imageregistry-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/config-operator-openshift-io-v1.adoc b/rest_api/operator_apis/config-operator-openshift-io-v1.adoc index 4db18e348684..8b9a3103eb8c 100644 --- a/rest_api/operator_apis/config-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/config-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="config-operator-openshift-io-v1"] = Config [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status defines the observed status of the Config Operator. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#configlist-operator-openshift-io-v1[`ConfigList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.ConfigList[`ConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 202 - Accepted +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config operator.openshift.io/v1`] +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-operator-openshift-io-v1.adoc#config-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/config-samples-operator-openshift-io-v1.adoc b/rest_api/operator_apis/config-samples-operator-openshift-io-v1.adoc index e6274c2ee079..71827ea9910f 100644 --- a/rest_api/operator_apis/config-samples-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/config-samples-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="config-samples-operator-openshift-io-v1"] = Config [samples.operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | ConfigStatus contains the actual configuration in effect, as well as various details that describe the state of the Samples Operator. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Type:: | skippedTemplates specifies names of templates that should NOT be created/updated. Admins can use this to allow them to delete content they don’t want. They will still have to manually delete the content but the operator will not recreate(or update) anything listed here. |=== -..status +=== .status Description:: + -- @@ -136,7 +138,7 @@ Type:: | version is the value of the operator's payload based version indicator when it was last successfully processed |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -149,7 +151,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -280,7 +282,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -337,7 +341,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#configlist-samples-operator-openshift-io-v1[`ConfigList samples.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.samples.v1.ConfigList[`ConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -364,7 +370,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema | |=== @@ -373,7 +379,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 202 - Accepted +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -427,7 +439,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -436,7 +448,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -463,7 +479,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -490,7 +508,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -499,7 +517,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -526,7 +546,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema | |=== @@ -535,7 +555,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== @@ -583,7 +607,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -610,7 +636,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -619,7 +645,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -646,7 +674,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema | |=== @@ -655,7 +683,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config samples.operator.openshift.io/v1`] +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 201 - Created +| xref:../operator_apis/config-samples-operator-openshift-io-v1.adoc#config-samples-operator-openshift-io-v1[`Config`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/console-operator-openshift-io-v1.adoc b/rest_api/operator_apis/console-operator-openshift-io-v1.adoc index 12a38cf2d398..9f89e97742bf 100644 --- a/rest_api/operator_apis/console-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/console-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="console-operator-openshift-io-v1"] = Console [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | ConsoleStatus defines the observed status of the Console. |=== -..spec +=== .spec Description:: + -- @@ -104,7 +106,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..spec.customization +=== .spec.customization Description:: + -- @@ -154,7 +156,7 @@ Type:: | quickStarts allows customization of available ConsoleQuickStart resources in console. |=== -..spec.customization.addPage +=== .spec.customization.addPage Description:: + -- @@ -176,7 +178,7 @@ Type:: | disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID. |=== -..spec.customization.customLogoFile +=== .spec.customization.customLogoFile Description:: + -- @@ -202,7 +204,7 @@ Type:: | |=== -..spec.customization.developerCatalog +=== .spec.customization.developerCatalog Description:: + -- @@ -228,7 +230,7 @@ Type:: | DeveloperConsoleCatalogCategory for the developer console catalog. |=== -..spec.customization.developerCatalog.categories +=== .spec.customization.developerCatalog.categories Description:: + -- @@ -241,7 +243,7 @@ Type:: -..spec.customization.developerCatalog.categories[] +=== .spec.customization.developerCatalog.categories[] Description:: + -- @@ -282,7 +284,7 @@ Required:: | tags is a list of strings that will match the category. A selected category show all items which has at least one overlapping tag between category and item. |=== -..spec.customization.developerCatalog.categories[].subcategories +=== .spec.customization.developerCatalog.categories[].subcategories Description:: + -- @@ -295,7 +297,7 @@ Type:: -..spec.customization.developerCatalog.categories[].subcategories[] +=== .spec.customization.developerCatalog.categories[].subcategories[] Description:: + -- @@ -328,7 +330,7 @@ Required:: | tags is a list of strings that will match the category. A selected category show all items which has at least one overlapping tag between category and item. |=== -..spec.customization.projectAccess +=== .spec.customization.projectAccess Description:: + -- @@ -350,7 +352,7 @@ Type:: | availableClusterRoles is the list of ClusterRole names that are assignable to users through the project access tab. |=== -..spec.customization.quickStarts +=== .spec.customization.quickStarts Description:: + -- @@ -372,7 +374,7 @@ Type:: | disabled is a list of ConsoleQuickStart resource names that are not shown to users. |=== -..spec.providers +=== .spec.providers Description:: + -- @@ -394,7 +396,7 @@ Type:: | statuspage contains ID for statuspage.io page that provides status info about. |=== -..spec.providers.statuspage +=== .spec.providers.statuspage Description:: + -- @@ -416,7 +418,7 @@ Type:: | pageID is the unique ID assigned by Statuspage for your page. This must be a public page. |=== -..spec.route +=== .spec.route Description:: + -- @@ -442,7 +444,7 @@ Type:: | secret points to secret in the openshift-config namespace that contains custom certificate and key and needs to be created manually by the cluster admin. Referenced Secret is required to contain following key value pairs: - "tls.crt" - to specifies custom certificate - "tls.key" - to specifies private key of the custom certificate If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. |=== -..spec.route.secret +=== .spec.route.secret Description:: + -- @@ -466,7 +468,7 @@ Required:: | name is the metadata.name of the referenced secret |=== -..status +=== .status Description:: + -- @@ -512,7 +514,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -525,7 +527,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -563,7 +565,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -576,7 +578,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -704,7 +706,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -761,7 +765,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#consolelist-operator-openshift-io-v1[`ConsoleList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.ConsoleList[`ConsoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -788,7 +794,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema | |=== @@ -797,7 +803,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 202 - Accepted +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== @@ -851,7 +863,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -860,7 +872,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -887,7 +903,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -914,7 +932,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -923,7 +941,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -950,7 +970,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema | |=== @@ -959,7 +979,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== @@ -1007,7 +1031,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1034,7 +1060,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1043,7 +1069,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1070,7 +1098,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema | |=== @@ -1079,7 +1107,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console operator.openshift.io/v1`] +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 201 - Created +| xref:../operator_apis/console-operator-openshift-io-v1.adoc#console-operator-openshift-io-v1[`Console`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc b/rest_api/operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc index f50816ee34dc..24725d20b6ad 100644 --- a/rest_api/operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="csisnapshotcontroller-operator-openshift-io-v1"] = CSISnapshotController [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#csisnapshotcontrollerlist-operator-openshift-io-v1[`CSISnapshotControllerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.CSISnapshotControllerList[`CSISnapshotControllerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 201 - Created +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 202 - Accepted +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 201 - Created +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController operator.openshift.io/v1`] +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 201 - Created +| xref:../operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc#csisnapshotcontroller-operator-openshift-io-v1[`CSISnapshotController`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/dns-operator-openshift-io-v1.adoc b/rest_api/operator_apis/dns-operator-openshift-io-v1.adoc index d7c067808613..f38b2cbdc5ea 100644 --- a/rest_api/operator_apis/dns-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/dns-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="dns-operator-openshift-io-v1"] = DNS [operator.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Type:: | status is the most recently observed status of the DNS. |=== -..spec +=== .spec Description:: + -- @@ -85,7 +87,7 @@ Type:: | Server defines the schema for a server that runs per instance of CoreDNS. |=== -..spec.nodePlacement +=== .spec.nodePlacement Description:: + -- @@ -123,7 +125,7 @@ Type:: | The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . |=== -..spec.nodePlacement.tolerations +=== .spec.nodePlacement.tolerations Description:: + -- @@ -138,7 +140,7 @@ Type:: -..spec.nodePlacement.tolerations[] +=== .spec.nodePlacement.tolerations[] Description:: + -- @@ -176,7 +178,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.servers +=== .spec.servers Description:: + -- @@ -191,7 +193,7 @@ Type:: -..spec.servers[] +=== .spec.servers[] Description:: + -- @@ -221,7 +223,7 @@ Type:: | zones is required and specifies the subdomains that server is authoritative for. Zones must conform to the rfc1123 definition of a subdomain. Specifying the cluster domain (i.e., "cluster.local") is invalid. |=== -..spec.servers[].forwardPlugin +=== .spec.servers[].forwardPlugin Description:: + -- @@ -248,8 +250,7 @@ Type:: A maximum of 15 `upstreams` is allowed per ForwardPlugin. |=== - -..status +=== .status Description:: + -- @@ -292,7 +293,7 @@ Required:: | OperatorCondition is just the standard condition fields. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -307,7 +308,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -431,7 +432,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -488,7 +491,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#dnslist-operator-openshift-io-v1[`DNSList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.DNSList[`DNSList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -515,8 +520,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] -| +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| |=== .HTTP responses @@ -524,7 +529,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 202 - Accepted +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== @@ -578,8 +589,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| |=== .HTTP responses @@ -587,7 +598,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -614,7 +629,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -641,8 +658,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -650,7 +667,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -677,8 +696,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] -| +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| |=== .HTTP responses @@ -686,7 +705,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== @@ -734,7 +757,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -761,8 +786,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -770,7 +795,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -797,8 +824,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] -| +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| |=== .HTTP responses @@ -806,5 +833,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS operator.openshift.io/v1`] +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 201 - Created +| xref:../operator_apis/dns-operator-openshift-io-v1.adoc#dns-operator-openshift-io-v1[`DNS`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc b/rest_api/operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc index cd1f1c1a7c4c..abd6b7e73c63 100644 --- a/rest_api/operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="dnsrecord-ingress-operator-openshift-io-v1"] = DNSRecord [ingress.operator.openshift.io/v1] ifdef::product-title[] @@ -34,7 +36,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -46,7 +48,7 @@ Type:: | status is the most recently observed status of the dnsRecord. |=== -..spec +=== .spec Description:: + -- @@ -85,7 +87,7 @@ Required:: | targets are record targets. |=== -..status +=== .status Description:: + -- @@ -115,7 +117,7 @@ Type:: | DNSZoneStatus is the status of a record within a specific zone. |=== -..status.zones +=== .status.zones Description:: + -- @@ -128,7 +130,7 @@ Type:: -..status.zones[] +=== .status.zones[] Description:: + -- @@ -159,7 +161,7 @@ Type:: | dnsZone is the zone where the record is published. |=== -..status.zones[].conditions +=== .status.zones[].conditions Description:: + -- @@ -173,7 +175,7 @@ Type:: -..status.zones[].conditions[] +=== .status.zones[].conditions[] Description:: + -- @@ -214,7 +216,7 @@ Required:: | |=== -..status.zones[].dnsZone +=== .status.zones[].dnsZone Description:: + -- @@ -325,7 +327,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#dnsrecordlist-ingress-operator-openshift-io-v1[`DNSRecordList ingress.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.ingress.v1.DNSRecordList[`DNSRecordList`] schema +| 401 - Unauthorized +| Empty |=== @@ -403,7 +407,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -460,7 +466,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#dnsrecordlist-ingress-operator-openshift-io-v1[`DNSRecordList ingress.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.ingress.v1.DNSRecordList[`DNSRecordList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -487,7 +495,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema | |=== @@ -496,7 +504,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 201 - Created +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 202 - Accepted +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== @@ -553,7 +567,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -562,7 +576,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -589,7 +607,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -616,7 +636,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -625,7 +645,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -652,7 +674,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema | |=== @@ -661,7 +683,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 201 - Created +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== @@ -712,7 +738,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -739,7 +767,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -748,7 +776,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -775,7 +805,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema | |=== @@ -784,7 +814,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord ingress.operator.openshift.io/v1`] +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 201 - Created +| xref:../operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc#dnsrecord-ingress-operator-openshift-io-v1[`DNSRecord`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc b/rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc index b79189e5ab7b..db7408f32136 100644 --- a/rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="etcd-operator-openshift-io-v1"] = Etcd [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -100,7 +102,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -162,7 +164,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -175,7 +177,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -213,7 +215,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -226,7 +228,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -268,7 +270,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.nodeStatuses +=== .status.nodeStatuses Description:: + -- @@ -281,7 +283,7 @@ Type:: -..status.nodeStatuses[] +=== .status.nodeStatuses[] Description:: + -- @@ -421,7 +423,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -478,7 +482,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#etcdlist-operator-openshift-io-v1[`EtcdList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.EtcdList[`EtcdList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -505,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema | |=== @@ -514,7 +520,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 201 - Created +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 202 - Accepted +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== @@ -568,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -577,7 +589,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +620,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -631,7 +649,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -640,7 +658,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -667,7 +687,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema | |=== @@ -676,7 +696,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 201 - Created +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== @@ -724,7 +748,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -751,7 +777,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -760,7 +786,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -787,7 +815,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema | |=== @@ -796,7 +824,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd operator.openshift.io/v1`] +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 201 - Created +| xref:../operator_apis/etcd-operator-openshift-io-v1.adoc#etcd-operator-openshift-io-v1[`Etcd`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc b/rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc index f06558b119fb..441084c770ca 100644 --- a/rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc +++ b/rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagecontentsourcepolicy-operator-openshift-io-v1alpha1"] = ImageContentSourcePolicy [operator.openshift.io/v1alpha1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -44,7 +46,7 @@ Required:: | spec holds user settable values for configuration |=== -..spec +=== .spec Description:: + -- @@ -72,7 +74,7 @@ Type:: | RepositoryDigestMirrors holds cluster-wide information about how to handle mirros in the registries config. Note: the mirrors only work when pulling the images that are referenced by their digests. |=== -..spec.repositoryDigestMirrors +=== .spec.repositoryDigestMirrors Description:: + -- @@ -87,7 +89,7 @@ Type:: -..spec.repositoryDigestMirrors[] +=== .spec.repositoryDigestMirrors[] Description:: + -- @@ -201,7 +203,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -258,7 +262,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imagecontentsourcepolicylist-operator-openshift-io-v1alpha1[`ImageContentSourcePolicyList operator.openshift.io/v1alpha1`] +| xref:../objects/index.adoc#io.openshift.operator.v1alpha1.ImageContentSourcePolicyList[`ImageContentSourcePolicyList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -285,7 +291,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema | |=== @@ -294,7 +300,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 201 - Created +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 202 - Accepted +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== @@ -348,7 +360,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -357,7 +369,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -384,7 +400,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -411,7 +429,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -420,7 +438,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -447,7 +467,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema | |=== @@ -456,7 +476,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 201 - Created +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== @@ -504,7 +528,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -531,7 +557,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -540,7 +566,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -567,7 +595,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema | |=== @@ -576,7 +604,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy operator.openshift.io/v1alpha1`] +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 201 - Created +| xref:../operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc#imagecontentsourcepolicy-operator-openshift-io-v1alpha1[`ImageContentSourcePolicy`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc b/rest_api/operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc index 9f945acf5aed..aea2eb6d1a53 100644 --- a/rest_api/operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="imagepruner-imageregistry-operator-openshift-io-v1"] = ImagePruner [imageregistry.operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | ImagePrunerStatus reports image pruner operational status. |=== -..spec +=== .spec Description:: + -- @@ -123,7 +125,7 @@ Type:: | The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . |=== -..spec.affinity +=== .spec.affinity Description:: + -- @@ -153,7 +155,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.affinity.nodeAffinity +=== .spec.affinity.nodeAffinity Description:: + -- @@ -183,7 +185,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -196,7 +198,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -225,7 +227,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -259,7 +261,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -272,7 +274,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -305,7 +307,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -318,7 +320,7 @@ Type:: -..spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -351,7 +353,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -379,7 +381,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -392,7 +394,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -426,7 +428,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -439,7 +441,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -472,7 +474,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -485,7 +487,7 @@ Type:: -..spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -518,7 +520,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity +=== .spec.affinity.podAffinity Description:: + -- @@ -552,7 +554,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -565,7 +567,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -594,7 +596,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -630,7 +632,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -660,7 +662,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -673,7 +675,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -706,7 +708,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -736,7 +738,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -749,7 +751,7 @@ Type:: -..spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -782,7 +784,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -795,7 +797,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -831,7 +833,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -861,7 +863,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -874,7 +876,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -907,7 +909,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -937,7 +939,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -950,7 +952,7 @@ Type:: -..spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -983,7 +985,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity +=== .spec.affinity.podAntiAffinity Description:: + -- @@ -1017,7 +1019,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1030,7 +1032,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1059,7 +1061,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -1095,7 +1097,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -1125,7 +1127,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -1138,7 +1140,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -1171,7 +1173,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -1201,7 +1203,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -1214,7 +1216,7 @@ Type:: -..spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -1247,7 +1249,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -1260,7 +1262,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -1296,7 +1298,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -1326,7 +1328,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -1339,7 +1341,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -1372,7 +1374,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -1402,7 +1404,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -1415,7 +1417,7 @@ Type:: -..spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -1448,7 +1450,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.resources +=== .spec.resources Description:: + -- @@ -1474,7 +1476,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.tolerations +=== .spec.tolerations Description:: + -- @@ -1487,7 +1489,7 @@ Type:: -..spec.tolerations[] +=== .spec.tolerations[] Description:: + -- @@ -1525,7 +1527,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..status +=== .status Description:: + -- @@ -1555,7 +1557,7 @@ Type:: | observedGeneration is the last generation change that has been applied. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -1568,7 +1570,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -1692,7 +1694,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1749,7 +1753,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#imageprunerlist-imageregistry-operator-openshift-io-v1[`ImagePrunerList imageregistry.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.imageregistry.v1.ImagePrunerList[`ImagePrunerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1776,7 +1782,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema | |=== @@ -1785,7 +1791,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 201 - Created +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 202 - Accepted +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== @@ -1839,7 +1851,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1848,7 +1860,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1875,7 +1891,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1902,7 +1920,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1911,7 +1929,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1938,7 +1958,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema | |=== @@ -1947,7 +1967,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 201 - Created +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== @@ -1995,7 +2019,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2022,7 +2048,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2031,7 +2057,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2058,7 +2086,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema | |=== @@ -2067,7 +2095,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner imageregistry.operator.openshift.io/v1`] +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 201 - Created +| xref:../operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc#imagepruner-imageregistry-operator-openshift-io-v1[`ImagePruner`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc b/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc index 80a6e6b3a38f..c23465b7f049 100644 --- a/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="ingresscontroller-operator-openshift-io-v1"] = IngressController [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Type:: | status is the most recently observed status of the IngressController. |=== -..spec +=== .spec Description:: + -- @@ -153,7 +155,7 @@ Type:: | unsupportedConfigOverrides allows specifying unsupported configuration options. Its use is unsupported. |=== -..spec.clientTLS +=== .spec.clientTLS Description:: + -- @@ -187,7 +189,7 @@ Required:: Note that the ingress controller only checks client certificates for edge-terminated and reencrypt TLS routes; it cannot check certificates for cleartext HTTP or passthrough TLS routes. |=== -..spec.clientTLS.clientCA +=== .spec.clientTLS.clientCA Description:: + -- @@ -211,7 +213,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.defaultCertificate +=== .spec.defaultCertificate Description:: + -- @@ -238,7 +240,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.endpointPublishingStrategy +=== .spec.endpointPublishingStrategy Description:: + -- @@ -297,7 +299,7 @@ Required:: In this configuration, the ingress controller deployment uses container networking. A NodePort Service is created to publish the deployment. The specific node ports are dynamically allocated by OpenShift; however, to support static port allocations, user changes to the node port field of the managed NodePort Service will preserved. |=== -..spec.endpointPublishingStrategy.hostNetwork +=== .spec.endpointPublishingStrategy.hostNetwork Description:: + -- @@ -323,7 +325,7 @@ Type:: The empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change. |=== -..spec.endpointPublishingStrategy.loadBalancer +=== .spec.endpointPublishingStrategy.loadBalancer Description:: + -- @@ -352,7 +354,7 @@ Required:: | scope indicates the scope at which the load balancer is exposed. Possible values are "External" and "Internal". |=== -..spec.endpointPublishingStrategy.loadBalancer.providerParameters +=== .spec.endpointPublishingStrategy.loadBalancer.providerParameters Description:: + -- @@ -387,7 +389,7 @@ Required:: | type is the underlying infrastructure provider for the load balancer. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "OpenStack", and "VSphere". |=== -..spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws +=== .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws Description:: + -- @@ -425,7 +427,7 @@ Required:: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb |=== -..spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer +=== .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer Description:: + -- @@ -438,7 +440,7 @@ Type:: -..spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer +=== .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer Description:: + -- @@ -451,7 +453,7 @@ Type:: -..spec.endpointPublishingStrategy.loadBalancer.providerParameters.gcp +=== .spec.endpointPublishingStrategy.loadBalancer.providerParameters.gcp Description:: + -- @@ -478,7 +480,7 @@ Type:: https://cloud.google.com/load-balancing/docs/internal#client_access |=== -..spec.endpointPublishingStrategy.nodePort +=== .spec.endpointPublishingStrategy.nodePort Description:: + -- @@ -504,7 +506,7 @@ Type:: The empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change. |=== -..spec.endpointPublishingStrategy.private +=== .spec.endpointPublishingStrategy.private Description:: + -- @@ -517,7 +519,7 @@ Type:: -..spec.httpErrorCodePages +=== .spec.httpErrorCodePages Description:: + -- @@ -541,7 +543,7 @@ Required:: | name is the metadata.name of the referenced config map |=== -..spec.httpHeaders +=== .spec.httpHeaders Description:: + -- @@ -581,7 +583,7 @@ Type:: If this field is empty, no such header is injected into requests. |=== -..spec.httpHeaders.uniqueId +=== .spec.httpHeaders.uniqueId Description:: + -- @@ -608,7 +610,7 @@ Type:: | name specifies the name of the HTTP header (for example, "unique-id") that the ingress controller should inject into HTTP requests. The field's value must be a valid HTTP header name as defined in RFC 2616 section 4.2. If the field is empty, no header is injected. |=== -..spec.logging +=== .spec.logging Description:: + -- @@ -631,7 +633,7 @@ Type:: If this field is empty, access logging is disabled. |=== -..spec.logging.access +=== .spec.logging.access Description:: + -- @@ -675,7 +677,7 @@ Required:: | logEmptyRequests specifies how connections on which no request is received should be logged. Typically, these empty requests come from load balancers' health probes or Web browsers' speculative connections ("preconnect"), in which case logging these requests may be undesirable. However, these requests may also be caused by network errors, in which case logging empty requests may be useful for diagnosing the errors. In addition, these requests may be caused by port scans, in which case logging empty requests may aid in detecting intrusion attempts. Allowed values for this field are "Log" and "Ignore". The default value is "Log". |=== -..spec.logging.access.destination +=== .spec.logging.access.destination Description:: + -- @@ -711,7 +713,7 @@ Required:: Logs are sent to a syslog endpoint. The administrator must specify an endpoint that can receive syslog messages. The expectation is that the administrator has configured a custom syslog instance. |=== -..spec.logging.access.destination.container +=== .spec.logging.access.destination.container Description:: + -- @@ -724,7 +726,7 @@ Type:: -..spec.logging.access.destination.syslog +=== .spec.logging.access.destination.syslog Description:: + -- @@ -758,7 +760,7 @@ Required:: | port is the UDP port number of the syslog endpoint that receives log messages. |=== -..spec.logging.access.httpCaptureHeaders +=== .spec.logging.access.httpCaptureHeaders Description:: + -- @@ -787,7 +789,7 @@ Type:: If this field is empty, no response headers are captured. |=== -..spec.namespaceSelector +=== .spec.namespaceSelector Description:: + -- @@ -818,7 +820,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.namespaceSelector.matchExpressions +=== .spec.namespaceSelector.matchExpressions Description:: + -- @@ -831,7 +833,7 @@ Type:: -..spec.namespaceSelector.matchExpressions[] +=== .spec.namespaceSelector.matchExpressions[] Description:: + -- @@ -864,7 +866,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.nodePlacement +=== .spec.nodePlacement Description:: + -- @@ -900,7 +902,7 @@ Type:: | The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . |=== -..spec.nodePlacement.nodeSelector +=== .spec.nodePlacement.nodeSelector Description:: + -- @@ -933,7 +935,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.nodePlacement.nodeSelector.matchExpressions +=== .spec.nodePlacement.nodeSelector.matchExpressions Description:: + -- @@ -946,7 +948,7 @@ Type:: -..spec.nodePlacement.nodeSelector.matchExpressions[] +=== .spec.nodePlacement.nodeSelector.matchExpressions[] Description:: + -- @@ -979,7 +981,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.nodePlacement.tolerations +=== .spec.nodePlacement.tolerations Description:: + -- @@ -994,7 +996,7 @@ Type:: -..spec.nodePlacement.tolerations[] +=== .spec.nodePlacement.tolerations[] Description:: + -- @@ -1032,7 +1034,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.routeAdmission +=== .spec.routeAdmission Description:: + -- @@ -1067,7 +1069,7 @@ Type:: If empty, defaults to "WildcardsDisallowed". |=== -..spec.routeSelector +=== .spec.routeSelector Description:: + -- @@ -1098,7 +1100,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.routeSelector.matchExpressions +=== .spec.routeSelector.matchExpressions Description:: + -- @@ -1111,7 +1113,7 @@ Type:: -..spec.routeSelector.matchExpressions[] +=== .spec.routeSelector.matchExpressions[] Description:: + -- @@ -1144,7 +1146,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.tlsSecurityProfile +=== .spec.tlsSecurityProfile Description:: + -- @@ -1198,7 +1200,7 @@ Type:: Note that the Modern profile is currently not supported because it is not yet well adopted by common software libraries. |=== -..spec.tuningOptions +=== .spec.tuningOptions Description:: + -- @@ -1263,7 +1265,7 @@ Type:: If unset, the default timeout is 1h |=== -..status +=== .status Description:: + -- @@ -1319,7 +1321,7 @@ Type:: | tlsProfile is the TLS connection configuration that is in effect. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -1338,7 +1340,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -1376,7 +1378,7 @@ Type:: | |=== -..status.endpointPublishingStrategy +=== .status.endpointPublishingStrategy Description:: + -- @@ -1431,7 +1433,7 @@ Required:: In this configuration, the ingress controller deployment uses container networking. A NodePort Service is created to publish the deployment. The specific node ports are dynamically allocated by OpenShift; however, to support static port allocations, user changes to the node port field of the managed NodePort Service will preserved. |=== -..status.endpointPublishingStrategy.hostNetwork +=== .status.endpointPublishingStrategy.hostNetwork Description:: + -- @@ -1457,7 +1459,7 @@ Type:: The empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change. |=== -..status.endpointPublishingStrategy.loadBalancer +=== .status.endpointPublishingStrategy.loadBalancer Description:: + -- @@ -1486,7 +1488,7 @@ Required:: | scope indicates the scope at which the load balancer is exposed. Possible values are "External" and "Internal". |=== -..status.endpointPublishingStrategy.loadBalancer.providerParameters +=== .status.endpointPublishingStrategy.loadBalancer.providerParameters Description:: + -- @@ -1521,7 +1523,7 @@ Required:: | type is the underlying infrastructure provider for the load balancer. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "OpenStack", and "VSphere". |=== -..status.endpointPublishingStrategy.loadBalancer.providerParameters.aws +=== .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws Description:: + -- @@ -1559,7 +1561,7 @@ Required:: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb |=== -..status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer +=== .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer Description:: + -- @@ -1572,7 +1574,7 @@ Type:: -..status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer +=== .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer Description:: + -- @@ -1585,7 +1587,7 @@ Type:: -..status.endpointPublishingStrategy.loadBalancer.providerParameters.gcp +=== .status.endpointPublishingStrategy.loadBalancer.providerParameters.gcp Description:: + -- @@ -1612,7 +1614,7 @@ Type:: https://cloud.google.com/load-balancing/docs/internal#client_access |=== -..status.endpointPublishingStrategy.nodePort +=== .status.endpointPublishingStrategy.nodePort Description:: + -- @@ -1638,7 +1640,7 @@ Type:: The empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change. |=== -..status.endpointPublishingStrategy.private +=== .status.endpointPublishingStrategy.private Description:: + -- @@ -1651,7 +1653,7 @@ Type:: -..status.tlsProfile +=== .status.tlsProfile Description:: + -- @@ -1765,7 +1767,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingresscontrollerlist-operator-openshift-io-v1[`IngressControllerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.IngressControllerList[`IngressControllerList`] schema +| 401 - Unauthorized +| Empty |=== @@ -1843,7 +1847,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1900,7 +1906,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#ingresscontrollerlist-operator-openshift-io-v1[`IngressControllerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.IngressControllerList[`IngressControllerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1927,7 +1935,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema | |=== @@ -1936,7 +1944,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 201 - Created +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 202 - Accepted +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== @@ -1993,7 +2007,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -2002,7 +2016,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2029,7 +2047,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2056,7 +2076,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2065,7 +2085,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2092,7 +2114,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema | |=== @@ -2101,7 +2123,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 201 - Created +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== @@ -2152,7 +2178,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2179,7 +2207,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2188,7 +2216,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2215,7 +2245,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema | |=== @@ -2224,7 +2254,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale_v2-autoscaling-v1[`Scale_v2 autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 201 - Created +| xref:../objects/index.adoc#io.k8s.api.autoscaling.v1.Scale_v2[`Scale_v2`] schema +| 401 - Unauthorized +| Empty |=== @@ -2275,7 +2309,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2302,7 +2338,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2311,7 +2347,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2338,7 +2376,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema | |=== @@ -2347,7 +2385,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController operator.openshift.io/v1`] +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 201 - Created +| xref:../operator_apis/ingresscontroller-operator-openshift-io-v1.adoc#ingresscontroller-operator-openshift-io-v1[`IngressController`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc b/rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc index 494ae68b6f84..a1ca57cdb5b4 100644 --- a/rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="kubeapiserver-operator-openshift-io-v1"] = KubeAPIServer [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status is the most recently observed status of the Kubernetes API Server |=== -..spec +=== .spec Description:: + -- @@ -100,7 +102,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -162,7 +164,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -175,7 +177,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -213,7 +215,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -226,7 +228,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -268,7 +270,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.nodeStatuses +=== .status.nodeStatuses Description:: + -- @@ -281,7 +283,7 @@ Type:: -..status.nodeStatuses[] +=== .status.nodeStatuses[] Description:: + -- @@ -421,7 +423,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -478,7 +482,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#kubeapiserverlist-operator-openshift-io-v1[`KubeAPIServerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.KubeAPIServerList[`KubeAPIServerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -505,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema | |=== @@ -514,7 +520,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 201 - Created +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 202 - Accepted +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -568,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -577,7 +589,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +620,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -631,7 +649,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -640,7 +658,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -667,7 +687,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema | |=== @@ -676,7 +696,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 201 - Created +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -724,7 +748,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -751,7 +777,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -760,7 +786,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -787,7 +815,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema | |=== @@ -796,7 +824,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 201 - Created +| xref:../operator_apis/kubeapiserver-operator-openshift-io-v1.adoc#kubeapiserver-operator-openshift-io-v1[`KubeAPIServer`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc b/rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc index 35cf3fee4093..2726780f3c5e 100644 --- a/rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="kubecontrollermanager-operator-openshift-io-v1"] = KubeControllerManager [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status is the most recently observed status of the Kubernetes Controller Manager |=== -..spec +=== .spec Description:: + -- @@ -104,7 +106,7 @@ Type:: | useMoreSecureServiceCA indicates that the service-ca.crt provided in SA token volumes should include only enough certificates to validate service serving certificates. Once set to true, it cannot be set to false. Even if someone finds a way to set it back to false, the service-ca.crt files that previously existed will only have the more secure content. |=== -..status +=== .status Description:: + -- @@ -166,7 +168,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -179,7 +181,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -217,7 +219,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -230,7 +232,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -272,7 +274,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.nodeStatuses +=== .status.nodeStatuses Description:: + -- @@ -285,7 +287,7 @@ Type:: -..status.nodeStatuses[] +=== .status.nodeStatuses[] Description:: + -- @@ -425,7 +427,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -482,7 +486,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#kubecontrollermanagerlist-operator-openshift-io-v1[`KubeControllerManagerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.KubeControllerManagerList[`KubeControllerManagerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +515,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema | |=== @@ -518,7 +524,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 201 - Created +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 202 - Accepted +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== @@ -572,7 +584,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -581,7 +593,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -608,7 +624,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -635,7 +653,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -644,7 +662,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -671,7 +691,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema | |=== @@ -680,7 +700,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 201 - Created +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== @@ -728,7 +752,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -755,7 +781,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -764,7 +790,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -791,7 +819,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema | |=== @@ -800,7 +828,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 201 - Created +| xref:../operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc#kubecontrollermanager-operator-openshift-io-v1[`KubeControllerManager`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc b/rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc index 94d96e846222..2ae794314cd7 100644 --- a/rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="kubescheduler-operator-openshift-io-v1"] = KubeScheduler [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status is the most recently observed status of the Kubernetes Scheduler |=== -..spec +=== .spec Description:: + -- @@ -100,7 +102,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -162,7 +164,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -175,7 +177,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -213,7 +215,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -226,7 +228,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -268,7 +270,7 @@ Type:: | resource is the resource type of the thing you're tracking |=== -..status.nodeStatuses +=== .status.nodeStatuses Description:: + -- @@ -281,7 +283,7 @@ Type:: -..status.nodeStatuses[] +=== .status.nodeStatuses[] Description:: + -- @@ -421,7 +423,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -478,7 +482,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#kubeschedulerlist-operator-openshift-io-v1[`KubeSchedulerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.KubeSchedulerList[`KubeSchedulerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -505,7 +511,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema | |=== @@ -514,7 +520,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 201 - Created +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 202 - Accepted +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== @@ -568,7 +580,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -577,7 +589,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +620,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -631,7 +649,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -640,7 +658,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -667,7 +687,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema | |=== @@ -676,7 +696,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 201 - Created +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== @@ -724,7 +748,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -751,7 +777,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -760,7 +786,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -787,7 +815,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema | |=== @@ -796,7 +824,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler operator.openshift.io/v1`] +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 201 - Created +| xref:../operator_apis/kubescheduler-operator-openshift-io-v1.adoc#kubescheduler-operator-openshift-io-v1[`KubeScheduler`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc b/rest_api/operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc index 3f7ea53e37ab..ffb775d2e9e2 100644 --- a/rest_api/operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="kubestorageversionmigrator-operator-openshift-io-v1"] = KubeStorageVersionMigrator [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#kubestorageversionmigratorlist-operator-openshift-io-v1[`KubeStorageVersionMigratorList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.KubeStorageVersionMigratorList[`KubeStorageVersionMigratorList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 201 - Created +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 202 - Accepted +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 201 - Created +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator operator.openshift.io/v1`] +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 201 - Created +| xref:../operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc#kubestorageversionmigrator-operator-openshift-io-v1[`KubeStorageVersionMigrator`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/network-operator-openshift-io-v1.adoc b/rest_api/operator_apis/network-operator-openshift-io-v1.adoc index b7c9bad0e9aa..71fb9d10207b 100644 --- a/rest_api/operator_apis/network-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/network-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="network-operator-openshift-io-v1"] = Network [operator.openshift.io/v1] ifdef::product-title[] @@ -10,7 +12,8 @@ toc::[] Description:: + -- -Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator. +Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -33,7 +36,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +48,7 @@ Type:: | NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object. |=== -..spec +=== .spec Description:: + -- @@ -137,7 +140,7 @@ Type:: | useMultiNetworkPolicy enables a controller which allows for MultiNetworkPolicy objects to be used on additional networks as created by Multus CNI. MultiNetworkPolicy are similar to NetworkPolicy objects, but NetworkPolicy objects only apply to the primary interface. With MultiNetworkPolicy, you can control the traffic that a pod can receive over the secondary interfaces. If unset, this property defaults to 'false' and MultiNetworkPolicy objects are ignored. If 'disableMultiNetwork' is 'true' then the value of this field is ignored. |=== -..spec.additionalNetworks +=== .spec.additionalNetworks Description:: + -- @@ -150,7 +153,7 @@ Type:: -..spec.additionalNetworks[] +=== .spec.additionalNetworks[] Description:: + -- @@ -188,7 +191,7 @@ Type:: | type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan |=== -..spec.additionalNetworks[].simpleMacvlanConfig +=== .spec.additionalNetworks[].simpleMacvlanConfig Description:: + -- @@ -222,7 +225,7 @@ Type:: | mtu is the mtu to use for the macvlan interface. if unset, host's kernel will select the value. |=== -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig Description:: + -- @@ -248,7 +251,7 @@ Type:: | Type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic |=== -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig Description:: + -- @@ -286,7 +289,7 @@ Type:: | StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes |=== -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses Description:: + -- @@ -299,7 +302,7 @@ Type:: -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[] +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[] Description:: + -- @@ -325,7 +328,7 @@ Type:: | Gateway is IP inside of subnet to designate as the gateway |=== -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns Description:: + -- @@ -355,7 +358,7 @@ Type:: | Search configures priority ordered search domains for short hostname lookups |=== -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes Description:: + -- @@ -368,7 +371,7 @@ Type:: -..spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[] +=== .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[] Description:: + -- @@ -394,7 +397,7 @@ Type:: | Gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin). |=== -..spec.clusterNetwork +=== .spec.clusterNetwork Description:: + -- @@ -407,7 +410,7 @@ Type:: -..spec.clusterNetwork[] +=== .spec.clusterNetwork[] Description:: + -- @@ -433,7 +436,7 @@ Type:: | |=== -..spec.defaultNetwork +=== .spec.defaultNetwork Description:: + -- @@ -467,7 +470,7 @@ Type:: | type is the type of network All NetworkTypes are supported except for NetworkTypeRaw |=== -..spec.defaultNetwork.kuryrConfig +=== .spec.defaultNetwork.kuryrConfig Description:: + -- @@ -517,7 +520,7 @@ Type:: | poolMinPorts sets a minimum number of free ports that should be kept in a port pool. If the number of ports is lower than this setting, new ports will get created and added to pool. The default is 1. For more information about port pools see enablePortPoolsPrepopulation setting. |=== -..spec.defaultNetwork.openshiftSDNConfig +=== .spec.defaultNetwork.openshiftSDNConfig Description:: + -- @@ -548,14 +551,14 @@ Type:: | `useExternalOpenvswitch` | `boolean` -| useExternalOpenvswitch tells the operator not to install openvswitch, because it will be provided separately. If set, you must provide it yourself. +| useExternalOpenvswitch used to control whether the operator would deploy an OVS DaemonSet itself or expect someone else to start OVS. As of 4.6, OVS is always run as a system service, and this flag is ignored. DEPRECATED: non-functional as of 4.6 | `vxlanPort` | `integer` | vxlanPort is the port to use for all vxlan packets. The default is 4789. |=== -..spec.defaultNetwork.ovnKubernetesConfig +=== .spec.defaultNetwork.ovnKubernetesConfig Description:: + -- @@ -593,7 +596,7 @@ Type:: | policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used. |=== -..spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig +=== .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig Description:: + -- @@ -623,7 +626,7 @@ Type:: | HybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789 |=== -..spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork +=== .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork Description:: + -- @@ -636,7 +639,7 @@ Type:: -..spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork[] +=== .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork[] Description:: + -- @@ -662,7 +665,7 @@ Type:: | |=== -..spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig +=== .spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig Description:: + -- @@ -675,7 +678,7 @@ Type:: -..spec.defaultNetwork.ovnKubernetesConfig.policyAuditConfig +=== .spec.defaultNetwork.ovnKubernetesConfig.policyAuditConfig Description:: + -- @@ -709,7 +712,7 @@ Type:: | syslogFacility the RFC5424 facility for generated messages, e.g. "kern". Default is "local0" |=== -..spec.exportNetworkFlows +=== .spec.exportNetworkFlows Description:: + -- @@ -739,7 +742,7 @@ Type:: | sFlow defines the SFlow configuration. |=== -..spec.exportNetworkFlows.ipfix +=== .spec.exportNetworkFlows.ipfix Description:: + -- @@ -761,7 +764,7 @@ Type:: | ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items |=== -..spec.exportNetworkFlows.netFlow +=== .spec.exportNetworkFlows.netFlow Description:: + -- @@ -783,7 +786,7 @@ Type:: | netFlow defines the NetFlow collectors that will consume the flow data exported from OVS. It is a list of strings formatted as ip:port with a maximum of ten items |=== -..spec.exportNetworkFlows.sFlow +=== .spec.exportNetworkFlows.sFlow Description:: + -- @@ -805,7 +808,7 @@ Type:: | sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items |=== -..spec.kubeProxyConfig +=== .spec.kubeProxyConfig Description:: + -- @@ -839,7 +842,7 @@ Type:: | ProxyArgumentList is a list of arguments to pass to the kubeproxy process |=== -..spec.kubeProxyConfig.proxyArguments +=== .spec.kubeProxyConfig.proxyArguments Description:: + -- @@ -852,7 +855,7 @@ Type:: -..spec.migration +=== .spec.migration Description:: + -- @@ -874,7 +877,7 @@ Type:: | networkType is the target type of network migration The supported values are OpenShiftSDN, OVNKubernetes |=== -..status +=== .status Description:: + -- @@ -920,7 +923,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -933,7 +936,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -971,7 +974,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -984,7 +987,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -1108,7 +1111,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1165,7 +1170,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#networklist-operator-openshift-io-v1[`NetworkList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.NetworkList[`NetworkList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1192,7 +1199,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema | |=== @@ -1201,7 +1208,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 201 - Created +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 202 - Accepted +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== @@ -1255,7 +1268,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -1264,7 +1277,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1291,7 +1308,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1318,7 +1337,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1327,7 +1346,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1354,7 +1375,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema | |=== @@ -1363,7 +1384,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network operator.openshift.io/v1`] +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 201 - Created +| xref:../operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[`Network`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc b/rest_api/operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc index 017a39169810..913e2e88ef7a 100644 --- a/rest_api/operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="openshiftapiserver-operator-openshift-io-v1"] = OpenShiftAPIServer [operator.openshift.io/v1] ifdef::product-title[] @@ -10,7 +12,8 @@ toc::[] Description:: + -- -OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver. +OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -35,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +50,7 @@ Required:: | status defines the observed status of the OpenShift API Server. |=== -..spec +=== .spec Description:: + -- @@ -87,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -137,7 +140,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -150,7 +153,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -188,7 +191,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -201,7 +204,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -329,7 +332,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -386,7 +391,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#openshiftapiserverlist-operator-openshift-io-v1[`OpenShiftAPIServerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.OpenShiftAPIServerList[`OpenShiftAPIServerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -413,7 +420,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema | |=== @@ -422,7 +429,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 201 - Created +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 202 - Accepted +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -476,7 +489,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -485,7 +498,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -512,7 +529,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +558,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -548,7 +567,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -575,7 +596,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema | |=== @@ -584,7 +605,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 201 - Created +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== @@ -632,7 +657,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -659,7 +686,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -668,7 +695,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -695,7 +724,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema | |=== @@ -704,7 +733,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer operator.openshift.io/v1`] +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 201 - Created +| xref:../operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc#openshiftapiserver-operator-openshift-io-v1[`OpenShiftAPIServer`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc b/rest_api/operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc index 057f67e9599f..e29ee4114768 100644 --- a/rest_api/operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="openshiftcontrollermanager-operator-openshift-io-v1"] = OpenShiftControllerManager [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#openshiftcontrollermanagerlist-operator-openshift-io-v1[`OpenShiftControllerManagerList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.OpenShiftControllerManagerList[`OpenShiftControllerManagerList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 201 - Created +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 202 - Accepted +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 201 - Created +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager operator.openshift.io/v1`] +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 201 - Created +| xref:../operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc#openshiftcontrollermanager-operator-openshift-io-v1[`OpenShiftControllerManager`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/operator-apis-index.adoc b/rest_api/operator_apis/operator-apis-index.adoc index 532512cb20da..39bb4b6b66e5 100644 --- a/rest_api/operator_apis/operator-apis-index.adoc +++ b/rest_api/operator_apis/operator-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operator-apis"] = Operator APIs ifdef::product-title[] @@ -11,7 +13,8 @@ toc::[] Description:: + -- -Authentication provides information to configure an operator to manage authentication. +Authentication provides information to configure an operator to manage authentication. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -225,7 +228,8 @@ Type:: Description:: + -- -Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator. +Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: @@ -236,7 +240,8 @@ Type:: Description:: + -- -OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver. +OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). -- Type:: diff --git a/rest_api/operator_apis/operatorpki-network-operator-openshift-io-v1.adoc b/rest_api/operator_apis/operatorpki-network-operator-openshift-io-v1.adoc index d45678b141b8..f827c8352619 100644 --- a/rest_api/operator_apis/operatorpki-network-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/operatorpki-network-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operatorpki-network-operator-openshift-io-v1"] = OperatorPKI [network.operator.openshift.io/v1] ifdef::product-title[] @@ -38,7 +40,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -50,7 +52,7 @@ Required:: | OperatorPKIStatus is not implemented. |=== -..spec +=== .spec Description:: + -- @@ -74,7 +76,7 @@ Required:: | targetCert configures the certificate signed by the CA. It will have both ClientAuth and ServerAuth enabled |=== -..spec.targetCert +=== .spec.targetCert Description:: + -- @@ -98,7 +100,7 @@ Required:: | commonName is the value in the certificate's CN |=== -..status +=== .status Description:: + -- @@ -188,7 +190,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorpkilist-network-operator-openshift-io-v1[`OperatorPKIList network.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.network.v1.OperatorPKIList[`OperatorPKIList`] schema +| 401 - Unauthorized +| Empty |=== @@ -266,7 +270,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -323,7 +329,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorpkilist-network-operator-openshift-io-v1[`OperatorPKIList network.operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.network.v1.OperatorPKIList[`OperatorPKIList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -350,7 +358,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema | |=== @@ -359,7 +367,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 201 - Created +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 202 - Accepted +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 401 - Unauthorized +| Empty |=== @@ -416,7 +430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -425,7 +439,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -452,7 +470,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -479,7 +499,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -488,7 +508,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -515,7 +537,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema | |=== @@ -524,7 +546,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI network.operator.openshift.io/v1`] +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 201 - Created +| xref:../operator_apis/operatorpki-network-operator-openshift-io-v1.adoc#operatorpki-network-operator-openshift-io-v1[`OperatorPKI`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc b/rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc index 48e0cb7d11d0..e7d9957de971 100644 --- a/rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="serviceca-operator-openshift-io-v1"] = ServiceCA [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#servicecalist-operator-openshift-io-v1[`ServiceCAList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.ServiceCAList[`ServiceCAList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 201 - Created +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 202 - Accepted +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 201 - Created +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA operator.openshift.io/v1`] +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 201 - Created +| xref:../operator_apis/serviceca-operator-openshift-io-v1.adoc#serviceca-operator-openshift-io-v1[`ServiceCA`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operator_apis/storage-operator-openshift-io-v1.adoc b/rest_api/operator_apis/storage-operator-openshift-io-v1.adoc index 20ffd848467d..ac40b340ab49 100644 --- a/rest_api/operator_apis/storage-operator-openshift-io-v1.adoc +++ b/rest_api/operator_apis/storage-operator-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="storage-operator-openshift-io-v1"] = Storage [operator.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | status holds observed values from the cluster. They may not be overridden. |=== -..spec +=== .spec Description:: + -- @@ -88,7 +90,7 @@ Type:: | unsupportedConfigOverrides holds a sparse config that will override any previously set options. It only needs to be the fields to override it will end up overlaying in the following order: 1. hardcoded defaults 2. observedConfig 3. unsupportedConfigOverrides |=== -..status +=== .status Description:: + -- @@ -134,7 +136,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -185,7 +187,7 @@ Type:: | |=== -..status.generations +=== .status.generations Description:: + -- @@ -198,7 +200,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -326,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -383,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#storagelist-operator-openshift-io-v1[`StorageList operator.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.operator.v1.StorageList[`StorageList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema | |=== @@ -419,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 201 - Created +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 202 - Accepted +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== @@ -473,7 +485,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -482,7 +494,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -509,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -536,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -545,7 +563,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -572,7 +592,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema | |=== @@ -581,7 +601,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 201 - Created +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== @@ -629,7 +653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -656,7 +682,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -665,7 +691,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -692,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema | |=== @@ -701,7 +729,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage operator.openshift.io/v1`] +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 201 - Created +| xref:../operator_apis/storage-operator-openshift-io-v1.adoc#storage-operator-openshift-io-v1[`Storage`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc b/rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc index 8f588f7cc112..5c6e1b69d75e 100644 --- a/rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc +++ b/rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="catalogsource-operators-coreos-com-v1alpha1"] = CatalogSource [operators.coreos.com/v1alpha1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -112,7 +114,7 @@ Required:: | UpdateStrategy defines how updated catalog source images can be discovered Consists of an interval that defines polling duration and an embedded strategy type |=== -..spec.icon +=== .spec.icon Description:: + -- @@ -141,7 +143,7 @@ Required:: | |=== -..spec.updateStrategy +=== .spec.updateStrategy Description:: + -- @@ -163,7 +165,7 @@ Type:: | |=== -..spec.updateStrategy.registryPoll +=== .spec.updateStrategy.registryPoll Description:: + -- @@ -185,7 +187,7 @@ Type:: | Interval is used to determine the time interval between checks of the latest catalog source version. The catalog operator polls to see if a new version of the catalog source is available. If available, the latest image is pulled and gRPC traffic is directed to the latest catalog source. |=== -..status +=== .status Description:: + -- @@ -236,7 +238,7 @@ Type:: | |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -249,7 +251,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -298,7 +300,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..status.configMapReference +=== .status.configMapReference Description:: + -- @@ -339,7 +341,7 @@ Required:: | UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. |=== -..status.connectionState +=== .status.connectionState Description:: + -- @@ -371,7 +373,7 @@ Required:: | |=== -..status.registryService +=== .status.registryService Description:: + -- @@ -490,7 +492,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#catalogsourcelist-operators-coreos-com-v1alpha1[`CatalogSourceList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.CatalogSourceList[`CatalogSourceList`] schema +| 401 - Unauthorized +| Empty |=== @@ -568,7 +572,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -625,7 +631,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#catalogsourcelist-operators-coreos-com-v1alpha1[`CatalogSourceList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.CatalogSourceList[`CatalogSourceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -652,7 +660,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema | |=== @@ -661,7 +669,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 201 - Created +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 202 - Accepted +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== @@ -718,7 +732,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -727,7 +741,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -754,7 +772,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -781,7 +801,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -790,7 +810,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -817,7 +839,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema | |=== @@ -826,7 +848,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 201 - Created +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== @@ -877,7 +903,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -904,7 +932,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -913,7 +941,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -940,7 +970,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema | |=== @@ -949,7 +979,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 201 - Created +| xref:../operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc#catalogsource-operators-coreos-com-v1alpha1[`CatalogSource`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc b/rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc index 83112d5d4fb6..c12630bd4448 100644 --- a/rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc +++ b/rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterserviceversion-operators-coreos-com-v1alpha1"] = ClusterServiceVersion [operators.coreos.com/v1alpha1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | ClusterServiceVersionStatus represents information about the status of a CSV. Status may trail the actual state of a system. |=== -..spec +=== .spec Description:: + -- @@ -190,7 +192,7 @@ Required:: | WebhookDescription provides details to OLM about required webhooks |=== -..spec.apiservicedefinitions +=== .spec.apiservicedefinitions Description:: + -- @@ -224,7 +226,7 @@ Type:: | APIServiceDescription provides details to OLM about apis provided via aggregation |=== -..spec.apiservicedefinitions.owned +=== .spec.apiservicedefinitions.owned Description:: + -- @@ -237,7 +239,7 @@ Type:: -..spec.apiservicedefinitions.owned[] +=== .spec.apiservicedefinitions.owned[] Description:: + -- @@ -324,7 +326,7 @@ Required:: | |=== -..spec.apiservicedefinitions.owned[].actionDescriptors +=== .spec.apiservicedefinitions.owned[].actionDescriptors Description:: + -- @@ -337,7 +339,7 @@ Type:: -..spec.apiservicedefinitions.owned[].actionDescriptors[] +=== .spec.apiservicedefinitions.owned[].actionDescriptors[] Description:: + -- @@ -377,7 +379,7 @@ Required:: | |=== -..spec.apiservicedefinitions.owned[].resources +=== .spec.apiservicedefinitions.owned[].resources Description:: + -- @@ -390,7 +392,7 @@ Type:: -..spec.apiservicedefinitions.owned[].resources[] +=== .spec.apiservicedefinitions.owned[].resources[] Description:: + -- @@ -424,7 +426,7 @@ Required:: | |=== -..spec.apiservicedefinitions.owned[].specDescriptors +=== .spec.apiservicedefinitions.owned[].specDescriptors Description:: + -- @@ -437,7 +439,7 @@ Type:: -..spec.apiservicedefinitions.owned[].specDescriptors[] +=== .spec.apiservicedefinitions.owned[].specDescriptors[] Description:: + -- @@ -477,7 +479,7 @@ Required:: | |=== -..spec.apiservicedefinitions.owned[].statusDescriptors +=== .spec.apiservicedefinitions.owned[].statusDescriptors Description:: + -- @@ -490,7 +492,7 @@ Type:: -..spec.apiservicedefinitions.owned[].statusDescriptors[] +=== .spec.apiservicedefinitions.owned[].statusDescriptors[] Description:: + -- @@ -530,7 +532,7 @@ Required:: | |=== -..spec.apiservicedefinitions.required +=== .spec.apiservicedefinitions.required Description:: + -- @@ -543,7 +545,7 @@ Type:: -..spec.apiservicedefinitions.required[] +=== .spec.apiservicedefinitions.required[] Description:: + -- @@ -630,7 +632,7 @@ Required:: | |=== -..spec.apiservicedefinitions.required[].actionDescriptors +=== .spec.apiservicedefinitions.required[].actionDescriptors Description:: + -- @@ -643,7 +645,7 @@ Type:: -..spec.apiservicedefinitions.required[].actionDescriptors[] +=== .spec.apiservicedefinitions.required[].actionDescriptors[] Description:: + -- @@ -683,7 +685,7 @@ Required:: | |=== -..spec.apiservicedefinitions.required[].resources +=== .spec.apiservicedefinitions.required[].resources Description:: + -- @@ -696,7 +698,7 @@ Type:: -..spec.apiservicedefinitions.required[].resources[] +=== .spec.apiservicedefinitions.required[].resources[] Description:: + -- @@ -730,7 +732,7 @@ Required:: | |=== -..spec.apiservicedefinitions.required[].specDescriptors +=== .spec.apiservicedefinitions.required[].specDescriptors Description:: + -- @@ -743,7 +745,7 @@ Type:: -..spec.apiservicedefinitions.required[].specDescriptors[] +=== .spec.apiservicedefinitions.required[].specDescriptors[] Description:: + -- @@ -783,7 +785,7 @@ Required:: | |=== -..spec.apiservicedefinitions.required[].statusDescriptors +=== .spec.apiservicedefinitions.required[].statusDescriptors Description:: + -- @@ -796,7 +798,7 @@ Type:: -..spec.apiservicedefinitions.required[].statusDescriptors[] +=== .spec.apiservicedefinitions.required[].statusDescriptors[] Description:: + -- @@ -836,7 +838,7 @@ Required:: | |=== -..spec.cleanup +=== .spec.cleanup Description:: + -- @@ -860,7 +862,7 @@ Required:: | |=== -..spec.customresourcedefinitions +=== .spec.customresourcedefinitions Description:: + -- @@ -895,7 +897,7 @@ Type:: | CRDDescription provides details to OLM about the CRDs |=== -..spec.customresourcedefinitions.owned +=== .spec.customresourcedefinitions.owned Description:: + -- @@ -908,7 +910,7 @@ Type:: -..spec.customresourcedefinitions.owned[] +=== .spec.customresourcedefinitions.owned[] Description:: + -- @@ -982,7 +984,7 @@ Required:: | |=== -..spec.customresourcedefinitions.owned[].actionDescriptors +=== .spec.customresourcedefinitions.owned[].actionDescriptors Description:: + -- @@ -995,7 +997,7 @@ Type:: -..spec.customresourcedefinitions.owned[].actionDescriptors[] +=== .spec.customresourcedefinitions.owned[].actionDescriptors[] Description:: + -- @@ -1035,7 +1037,7 @@ Required:: | |=== -..spec.customresourcedefinitions.owned[].resources +=== .spec.customresourcedefinitions.owned[].resources Description:: + -- @@ -1048,7 +1050,7 @@ Type:: -..spec.customresourcedefinitions.owned[].resources[] +=== .spec.customresourcedefinitions.owned[].resources[] Description:: + -- @@ -1082,7 +1084,7 @@ Required:: | |=== -..spec.customresourcedefinitions.owned[].specDescriptors +=== .spec.customresourcedefinitions.owned[].specDescriptors Description:: + -- @@ -1095,7 +1097,7 @@ Type:: -..spec.customresourcedefinitions.owned[].specDescriptors[] +=== .spec.customresourcedefinitions.owned[].specDescriptors[] Description:: + -- @@ -1135,7 +1137,7 @@ Required:: | |=== -..spec.customresourcedefinitions.owned[].statusDescriptors +=== .spec.customresourcedefinitions.owned[].statusDescriptors Description:: + -- @@ -1148,7 +1150,7 @@ Type:: -..spec.customresourcedefinitions.owned[].statusDescriptors[] +=== .spec.customresourcedefinitions.owned[].statusDescriptors[] Description:: + -- @@ -1188,7 +1190,7 @@ Required:: | |=== -..spec.customresourcedefinitions.required +=== .spec.customresourcedefinitions.required Description:: + -- @@ -1201,7 +1203,7 @@ Type:: -..spec.customresourcedefinitions.required[] +=== .spec.customresourcedefinitions.required[] Description:: + -- @@ -1275,7 +1277,7 @@ Required:: | |=== -..spec.customresourcedefinitions.required[].actionDescriptors +=== .spec.customresourcedefinitions.required[].actionDescriptors Description:: + -- @@ -1288,7 +1290,7 @@ Type:: -..spec.customresourcedefinitions.required[].actionDescriptors[] +=== .spec.customresourcedefinitions.required[].actionDescriptors[] Description:: + -- @@ -1328,7 +1330,7 @@ Required:: | |=== -..spec.customresourcedefinitions.required[].resources +=== .spec.customresourcedefinitions.required[].resources Description:: + -- @@ -1341,7 +1343,7 @@ Type:: -..spec.customresourcedefinitions.required[].resources[] +=== .spec.customresourcedefinitions.required[].resources[] Description:: + -- @@ -1375,7 +1377,7 @@ Required:: | |=== -..spec.customresourcedefinitions.required[].specDescriptors +=== .spec.customresourcedefinitions.required[].specDescriptors Description:: + -- @@ -1388,7 +1390,7 @@ Type:: -..spec.customresourcedefinitions.required[].specDescriptors[] +=== .spec.customresourcedefinitions.required[].specDescriptors[] Description:: + -- @@ -1428,7 +1430,7 @@ Required:: | |=== -..spec.customresourcedefinitions.required[].statusDescriptors +=== .spec.customresourcedefinitions.required[].statusDescriptors Description:: + -- @@ -1441,7 +1443,7 @@ Type:: -..spec.customresourcedefinitions.required[].statusDescriptors[] +=== .spec.customresourcedefinitions.required[].statusDescriptors[] Description:: + -- @@ -1481,7 +1483,7 @@ Required:: | |=== -..spec.icon +=== .spec.icon Description:: + -- @@ -1494,7 +1496,7 @@ Type:: -..spec.icon[] +=== .spec.icon[] Description:: + -- @@ -1523,7 +1525,7 @@ Required:: | |=== -..spec.install +=== .spec.install Description:: + -- @@ -1551,7 +1553,7 @@ Required:: | |=== -..spec.install.spec +=== .spec.install.spec Description:: + -- @@ -1595,7 +1597,7 @@ Required:: | StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy |=== -..spec.install.spec.clusterPermissions +=== .spec.install.spec.clusterPermissions Description:: + -- @@ -1608,7 +1610,7 @@ Type:: -..spec.install.spec.clusterPermissions[] +=== .spec.install.spec.clusterPermissions[] Description:: + -- @@ -1641,7 +1643,7 @@ Required:: | |=== -..spec.install.spec.clusterPermissions[].rules +=== .spec.install.spec.clusterPermissions[].rules Description:: + -- @@ -1654,7 +1656,7 @@ Type:: -..spec.install.spec.clusterPermissions[].rules[] +=== .spec.install.spec.clusterPermissions[].rules[] Description:: + -- @@ -1694,7 +1696,7 @@ Required:: | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs. |=== -..spec.install.spec.deployments +=== .spec.install.spec.deployments Description:: + -- @@ -1707,7 +1709,7 @@ Type:: -..spec.install.spec.deployments[] +=== .spec.install.spec.deployments[] Description:: + -- @@ -1740,7 +1742,7 @@ Required:: | DeploymentSpec is the specification of the desired behavior of the Deployment. |=== -..spec.install.spec.deployments[].spec +=== .spec.install.spec.deployments[].spec Description:: + -- @@ -1793,7 +1795,7 @@ Required:: | Template describes the pods that will be created. |=== -..spec.install.spec.deployments[].spec.selector +=== .spec.install.spec.deployments[].spec.selector Description:: + -- @@ -1823,7 +1825,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.selector.matchExpressions +=== .spec.install.spec.deployments[].spec.selector.matchExpressions Description:: + -- @@ -1836,7 +1838,7 @@ Type:: -..spec.install.spec.deployments[].spec.selector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.selector.matchExpressions[] Description:: + -- @@ -1869,7 +1871,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.strategy +=== .spec.install.spec.deployments[].spec.strategy Description:: + -- @@ -1895,7 +1897,7 @@ Type:: | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |=== -..spec.install.spec.deployments[].spec.strategy.rollingUpdate +=== .spec.install.spec.deployments[].spec.strategy.rollingUpdate Description:: + -- @@ -1921,7 +1923,7 @@ Type:: | The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |=== -..spec.install.spec.deployments[].spec.template +=== .spec.install.spec.deployments[].spec.template Description:: + -- @@ -1947,7 +1949,7 @@ Type:: | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |=== -..spec.install.spec.deployments[].spec.template.spec +=== .spec.install.spec.deployments[].spec.template.spec Description:: + -- @@ -2143,7 +2145,7 @@ Required:: | Volume represents a named volume in a pod that may be accessed by any container in the pod. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity +=== .spec.install.spec.deployments[].spec.template.spec.affinity Description:: + -- @@ -2173,7 +2175,7 @@ Type:: | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity Description:: + -- @@ -2203,7 +2205,7 @@ Type:: | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -2216,7 +2218,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -2245,7 +2247,7 @@ Required:: | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference Description:: + -- @@ -2279,7 +2281,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions Description:: + -- @@ -2292,7 +2294,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] Description:: + -- @@ -2325,7 +2327,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields Description:: + -- @@ -2338,7 +2340,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] Description:: + -- @@ -2371,7 +2373,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -2399,7 +2401,7 @@ Required:: | A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms Description:: + -- @@ -2412,7 +2414,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] Description:: + -- @@ -2446,7 +2448,7 @@ Type:: | A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions Description:: + -- @@ -2459,7 +2461,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] Description:: + -- @@ -2492,7 +2494,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields Description:: + -- @@ -2505,7 +2507,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] Description:: + -- @@ -2538,7 +2540,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity Description:: + -- @@ -2572,7 +2574,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -2585,7 +2587,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -2614,7 +2616,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -2650,7 +2652,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -2680,7 +2682,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -2693,7 +2695,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -2726,7 +2728,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -2756,7 +2758,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -2769,7 +2771,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -2802,7 +2804,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -2815,7 +2817,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -2851,7 +2853,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -2881,7 +2883,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -2894,7 +2896,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -2927,7 +2929,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -2957,7 +2959,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -2970,7 +2972,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -3003,7 +3005,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity Description:: + -- @@ -3037,7 +3039,7 @@ Type:: | Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -3050,7 +3052,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -3079,7 +3081,7 @@ Required:: | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm Description:: + -- @@ -3115,7 +3117,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector Description:: + -- @@ -3145,7 +3147,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions Description:: + -- @@ -3158,7 +3160,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[] Description:: + -- @@ -3191,7 +3193,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector Description:: + -- @@ -3221,7 +3223,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions Description:: + -- @@ -3234,7 +3236,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[] Description:: + -- @@ -3267,7 +3269,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution Description:: + -- @@ -3280,7 +3282,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] Description:: + -- @@ -3316,7 +3318,7 @@ Required:: | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector Description:: + -- @@ -3346,7 +3348,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions Description:: + -- @@ -3359,7 +3361,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[] Description:: + -- @@ -3392,7 +3394,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector Description:: + -- @@ -3422,7 +3424,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions Description:: + -- @@ -3435,7 +3437,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[] Description:: + -- @@ -3468,7 +3470,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.containers +=== .spec.install.spec.deployments[].spec.template.spec.containers Description:: + -- @@ -3481,7 +3483,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[] Description:: + -- @@ -3609,7 +3611,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env Description:: + -- @@ -3622,7 +3624,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].env[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[] Description:: + -- @@ -3654,7 +3656,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom Description:: + -- @@ -3688,7 +3690,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -3720,7 +3722,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef Description:: + -- @@ -3748,7 +3750,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.resourceFieldRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -3780,7 +3782,7 @@ Required:: | Required: resource to select |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.secretKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -3812,7 +3814,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].envFrom +=== .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom Description:: + -- @@ -3825,7 +3827,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[] Description:: + -- @@ -3855,7 +3857,7 @@ Type:: | The Secret to select from |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef Description:: + -- @@ -3881,7 +3883,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef +=== .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef Description:: + -- @@ -3907,7 +3909,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle Description:: + -- @@ -3933,7 +3935,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart Description:: + -- @@ -3963,7 +3965,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec Description:: + -- @@ -3985,7 +3987,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet Description:: + -- @@ -4029,7 +4031,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -4042,7 +4044,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -4071,7 +4073,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -4099,7 +4101,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop Description:: + -- @@ -4129,7 +4131,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec Description:: + -- @@ -4151,7 +4153,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet Description:: + -- @@ -4195,7 +4197,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -4208,7 +4210,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -4237,7 +4239,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -4265,7 +4267,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe Description:: + -- @@ -4319,7 +4321,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec Description:: + -- @@ -4341,7 +4343,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet Description:: + -- @@ -4385,7 +4387,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -4398,7 +4400,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4427,7 +4429,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.tcpSocket Description:: + -- @@ -4455,7 +4457,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].ports +=== .spec.install.spec.deployments[].spec.template.spec.containers[].ports Description:: + -- @@ -4468,7 +4470,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].ports[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].ports[] Description:: + -- @@ -4508,7 +4510,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe Description:: + -- @@ -4562,7 +4564,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec Description:: + -- @@ -4584,7 +4586,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet Description:: + -- @@ -4628,7 +4630,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -4641,7 +4643,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -4670,7 +4672,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.tcpSocket Description:: + -- @@ -4698,7 +4700,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].resources +=== .spec.install.spec.deployments[].spec.template.spec.containers[].resources Description:: + -- @@ -4724,7 +4726,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].securityContext +=== .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext Description:: + -- @@ -4786,7 +4788,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities +=== .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities Description:: + -- @@ -4812,7 +4814,7 @@ Type:: | Removed capabilities |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions +=== .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions Description:: + -- @@ -4846,7 +4848,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seccompProfile +=== .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seccompProfile Description:: + -- @@ -4875,7 +4877,7 @@ Required:: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.windowsOptions +=== .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.windowsOptions Description:: + -- @@ -4909,7 +4911,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe Description:: + -- @@ -4963,7 +4965,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec Description:: + -- @@ -4985,7 +4987,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet Description:: + -- @@ -5029,7 +5031,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -5042,7 +5044,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -5071,7 +5073,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.tcpSocket Description:: + -- @@ -5099,7 +5101,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices +=== .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices Description:: + -- @@ -5112,7 +5114,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[] Description:: + -- @@ -5141,7 +5143,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts +=== .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts Description:: + -- @@ -5154,7 +5156,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[] +=== .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[] Description:: + -- @@ -5199,7 +5201,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.install.spec.deployments[].spec.template.spec.dnsConfig +=== .spec.install.spec.deployments[].spec.template.spec.dnsConfig Description:: + -- @@ -5233,7 +5235,7 @@ Type:: | A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. |=== -..spec.install.spec.deployments[].spec.template.spec.dnsConfig.options +=== .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options Description:: + -- @@ -5246,7 +5248,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[] +=== .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[] Description:: + -- @@ -5272,7 +5274,7 @@ Type:: | |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers Description:: + -- @@ -5285,7 +5287,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[] Description:: + -- @@ -5417,7 +5419,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env Description:: + -- @@ -5430,7 +5432,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[] Description:: + -- @@ -5462,7 +5464,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom Description:: + -- @@ -5496,7 +5498,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -5528,7 +5530,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef Description:: + -- @@ -5556,7 +5558,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -5588,7 +5590,7 @@ Required:: | Required: resource to select |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -5620,7 +5622,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom Description:: + -- @@ -5633,7 +5635,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[] Description:: + -- @@ -5663,7 +5665,7 @@ Type:: | The Secret to select from |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef Description:: + -- @@ -5689,7 +5691,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef Description:: + -- @@ -5715,7 +5717,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle Description:: + -- @@ -5741,7 +5743,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart Description:: + -- @@ -5771,7 +5773,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec Description:: + -- @@ -5793,7 +5795,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet Description:: + -- @@ -5837,7 +5839,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -5850,7 +5852,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -5879,7 +5881,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -5907,7 +5909,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop Description:: + -- @@ -5937,7 +5939,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec Description:: + -- @@ -5959,7 +5961,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet Description:: + -- @@ -6003,7 +6005,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -6016,7 +6018,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -6045,7 +6047,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -6073,7 +6075,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe Description:: + -- @@ -6127,7 +6129,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec Description:: + -- @@ -6149,7 +6151,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet Description:: + -- @@ -6193,7 +6195,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -6206,7 +6208,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -6235,7 +6237,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket Description:: + -- @@ -6263,7 +6265,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports Description:: + -- @@ -6276,7 +6278,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports[] Description:: + -- @@ -6316,7 +6318,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe Description:: + -- @@ -6370,7 +6372,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec Description:: + -- @@ -6392,7 +6394,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet Description:: + -- @@ -6436,7 +6438,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -6449,7 +6451,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -6478,7 +6480,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket Description:: + -- @@ -6506,7 +6508,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources Description:: + -- @@ -6532,7 +6534,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext Description:: + -- @@ -6594,7 +6596,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities Description:: + -- @@ -6620,7 +6622,7 @@ Type:: | Removed capabilities |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions Description:: + -- @@ -6654,7 +6656,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seccompProfile +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seccompProfile Description:: + -- @@ -6683,7 +6685,7 @@ Required:: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.windowsOptions +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.windowsOptions Description:: + -- @@ -6717,7 +6719,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe Description:: + -- @@ -6771,7 +6773,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec Description:: + -- @@ -6793,7 +6795,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet Description:: + -- @@ -6837,7 +6839,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -6850,7 +6852,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -6879,7 +6881,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket Description:: + -- @@ -6907,7 +6909,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices Description:: + -- @@ -6920,7 +6922,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[] Description:: + -- @@ -6949,7 +6951,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts Description:: + -- @@ -6962,7 +6964,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[] +=== .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[] Description:: + -- @@ -7007,7 +7009,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.install.spec.deployments[].spec.template.spec.hostAliases +=== .spec.install.spec.deployments[].spec.template.spec.hostAliases Description:: + -- @@ -7020,7 +7022,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.hostAliases[] +=== .spec.install.spec.deployments[].spec.template.spec.hostAliases[] Description:: + -- @@ -7046,7 +7048,7 @@ Type:: | IP address of the host file entry. |=== -..spec.install.spec.deployments[].spec.template.spec.imagePullSecrets +=== .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets Description:: + -- @@ -7059,7 +7061,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[] +=== .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[] Description:: + -- @@ -7081,7 +7083,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers +=== .spec.install.spec.deployments[].spec.template.spec.initContainers Description:: + -- @@ -7094,7 +7096,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[] Description:: + -- @@ -7222,7 +7224,7 @@ Required:: | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env Description:: + -- @@ -7235,7 +7237,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[] Description:: + -- @@ -7267,7 +7269,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom Description:: + -- @@ -7301,7 +7303,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef Description:: + -- @@ -7333,7 +7335,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef Description:: + -- @@ -7361,7 +7363,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef Description:: + -- @@ -7393,7 +7395,7 @@ Required:: | Required: resource to select |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef Description:: + -- @@ -7425,7 +7427,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom Description:: + -- @@ -7438,7 +7440,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[] Description:: + -- @@ -7468,7 +7470,7 @@ Type:: | The Secret to select from |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef Description:: + -- @@ -7494,7 +7496,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef Description:: + -- @@ -7520,7 +7522,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle Description:: + -- @@ -7546,7 +7548,7 @@ Type:: | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart Description:: + -- @@ -7576,7 +7578,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec Description:: + -- @@ -7598,7 +7600,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet Description:: + -- @@ -7642,7 +7644,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders Description:: + -- @@ -7655,7 +7657,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] Description:: + -- @@ -7684,7 +7686,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket Description:: + -- @@ -7712,7 +7714,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop Description:: + -- @@ -7742,7 +7744,7 @@ Type:: | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec Description:: + -- @@ -7764,7 +7766,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet Description:: + -- @@ -7808,7 +7810,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders Description:: + -- @@ -7821,7 +7823,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] Description:: + -- @@ -7850,7 +7852,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket Description:: + -- @@ -7878,7 +7880,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe Description:: + -- @@ -7932,7 +7934,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec Description:: + -- @@ -7954,7 +7956,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet Description:: + -- @@ -7998,7 +8000,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders Description:: + -- @@ -8011,7 +8013,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[] Description:: + -- @@ -8040,7 +8042,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.tcpSocket Description:: + -- @@ -8068,7 +8070,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].ports +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports Description:: + -- @@ -8081,7 +8083,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].ports[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports[] Description:: + -- @@ -8121,7 +8123,7 @@ Required:: | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe Description:: + -- @@ -8175,7 +8177,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec Description:: + -- @@ -8197,7 +8199,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet Description:: + -- @@ -8241,7 +8243,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders Description:: + -- @@ -8254,7 +8256,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[] Description:: + -- @@ -8283,7 +8285,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.tcpSocket Description:: + -- @@ -8311,7 +8313,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].resources +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].resources Description:: + -- @@ -8337,7 +8339,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext Description:: + -- @@ -8399,7 +8401,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities Description:: + -- @@ -8425,7 +8427,7 @@ Type:: | Removed capabilities |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions Description:: + -- @@ -8459,7 +8461,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seccompProfile +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seccompProfile Description:: + -- @@ -8488,7 +8490,7 @@ Required:: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.windowsOptions +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.windowsOptions Description:: + -- @@ -8522,7 +8524,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe Description:: + -- @@ -8576,7 +8578,7 @@ Type:: | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec Description:: + -- @@ -8598,7 +8600,7 @@ Type:: | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet Description:: + -- @@ -8642,7 +8644,7 @@ Required:: | Scheme to use for connecting to the host. Defaults to HTTP. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders Description:: + -- @@ -8655,7 +8657,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[] Description:: + -- @@ -8684,7 +8686,7 @@ Required:: | The header field value |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.tcpSocket +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.tcpSocket Description:: + -- @@ -8712,7 +8714,7 @@ Required:: | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices Description:: + -- @@ -8725,7 +8727,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[] Description:: + -- @@ -8754,7 +8756,7 @@ Required:: | name must match the name of a persistentVolumeClaim in the pod |=== -..spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts Description:: + -- @@ -8767,7 +8769,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[] +=== .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[] Description:: + -- @@ -8812,7 +8814,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.install.spec.deployments[].spec.template.spec.readinessGates +=== .spec.install.spec.deployments[].spec.template.spec.readinessGates Description:: + -- @@ -8825,7 +8827,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.readinessGates[] +=== .spec.install.spec.deployments[].spec.template.spec.readinessGates[] Description:: + -- @@ -8849,7 +8851,7 @@ Required:: | ConditionType refers to a condition in the pod's condition list with matching type. |=== -..spec.install.spec.deployments[].spec.template.spec.securityContext +=== .spec.install.spec.deployments[].spec.template.spec.securityContext Description:: + -- @@ -8913,7 +8915,7 @@ Type:: | The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.securityContext.seLinuxOptions +=== .spec.install.spec.deployments[].spec.template.spec.securityContext.seLinuxOptions Description:: + -- @@ -8947,7 +8949,7 @@ Type:: | User is a SELinux user label that applies to the container. |=== -..spec.install.spec.deployments[].spec.template.spec.securityContext.seccompProfile +=== .spec.install.spec.deployments[].spec.template.spec.securityContext.seccompProfile Description:: + -- @@ -8976,7 +8978,7 @@ Required:: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. |=== -..spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls +=== .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls Description:: + -- @@ -8989,7 +8991,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[] +=== .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[] Description:: + -- @@ -9018,7 +9020,7 @@ Required:: | Value of a property to set |=== -..spec.install.spec.deployments[].spec.template.spec.securityContext.windowsOptions +=== .spec.install.spec.deployments[].spec.template.spec.securityContext.windowsOptions Description:: + -- @@ -9052,7 +9054,7 @@ Type:: | The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |=== -..spec.install.spec.deployments[].spec.template.spec.tolerations +=== .spec.install.spec.deployments[].spec.template.spec.tolerations Description:: + -- @@ -9065,7 +9067,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.tolerations[] +=== .spec.install.spec.deployments[].spec.template.spec.tolerations[] Description:: + -- @@ -9103,7 +9105,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints +=== .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints Description:: + -- @@ -9116,7 +9118,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[] +=== .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[] Description:: + -- @@ -9154,7 +9156,7 @@ Required:: | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. |=== -..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector +=== .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector Description:: + -- @@ -9184,7 +9186,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions Description:: + -- @@ -9197,7 +9199,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[] Description:: + -- @@ -9230,7 +9232,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes +=== .spec.install.spec.deployments[].spec.template.spec.volumes Description:: + -- @@ -9243,7 +9245,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[] Description:: + -- @@ -9388,7 +9390,7 @@ Required:: | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].awsElasticBlockStore +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].awsElasticBlockStore Description:: + -- @@ -9424,7 +9426,7 @@ Required:: | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk Description:: + -- @@ -9469,7 +9471,7 @@ Required:: | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile Description:: + -- @@ -9502,7 +9504,7 @@ Required:: | Share Name |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs Description:: + -- @@ -9546,7 +9548,7 @@ Required:: | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef Description:: + -- @@ -9568,7 +9570,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].cinder +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder Description:: + -- @@ -9604,7 +9606,7 @@ Required:: | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].cinder.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder.secretRef Description:: + -- @@ -9626,7 +9628,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].configMap +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap Description:: + -- @@ -9664,7 +9666,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items Description:: + -- @@ -9677,7 +9679,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[] Description:: + -- @@ -9710,7 +9712,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].csi +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].csi Description:: + -- @@ -9750,7 +9752,7 @@ Required:: | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].csi.nodePublishSecretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].csi.nodePublishSecretRef Description:: + -- @@ -9772,7 +9774,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI Description:: + -- @@ -9802,7 +9804,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items Description:: + -- @@ -9815,7 +9817,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[] Description:: + -- @@ -9851,7 +9853,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].fieldRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].fieldRef Description:: + -- @@ -9879,7 +9881,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -9911,7 +9913,7 @@ Required:: | Required: resource to select |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].emptyDir +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].emptyDir Description:: + -- @@ -9937,7 +9939,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral Description:: + -- @@ -9967,7 +9969,7 @@ Type:: Required, must not be nil. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate Description:: + -- @@ -9998,7 +10000,7 @@ Required:: | The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.metadata +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.metadata Description:: + -- @@ -10011,7 +10013,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec Description:: + -- @@ -10061,7 +10063,7 @@ Type:: | VolumeName is the binding reference to the PersistentVolume backing this claim. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Description:: + -- @@ -10094,7 +10096,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Description:: + -- @@ -10127,7 +10129,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources Description:: + -- @@ -10153,7 +10155,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector Description:: + -- @@ -10183,7 +10185,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Description:: + -- @@ -10196,7 +10198,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Description:: + -- @@ -10229,7 +10231,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].fc +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].fc Description:: + -- @@ -10267,7 +10269,7 @@ Type:: | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume Description:: + -- @@ -10307,7 +10309,7 @@ Required:: | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef Description:: + -- @@ -10329,7 +10331,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].flocker +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].flocker Description:: + -- @@ -10355,7 +10357,7 @@ Type:: | UUID of the dataset. This is unique identifier of a Flocker dataset |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].gcePersistentDisk +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].gcePersistentDisk Description:: + -- @@ -10391,7 +10393,7 @@ Required:: | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].gitRepo +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].gitRepo Description:: + -- @@ -10423,7 +10425,7 @@ Required:: | Commit hash for the specified revision. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs Description:: + -- @@ -10456,7 +10458,7 @@ Required:: | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].hostPath +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].hostPath Description:: + -- @@ -10484,7 +10486,7 @@ Required:: | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi Description:: + -- @@ -10550,7 +10552,7 @@ Required:: | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef Description:: + -- @@ -10572,7 +10574,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].nfs +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].nfs Description:: + -- @@ -10605,7 +10607,7 @@ Required:: | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].persistentVolumeClaim +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].persistentVolumeClaim Description:: + -- @@ -10633,7 +10635,7 @@ Required:: | Will force the ReadOnly setting in VolumeMounts. Default false. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].photonPersistentDisk +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].photonPersistentDisk Description:: + -- @@ -10661,7 +10663,7 @@ Required:: | ID that identifies Photon Controller persistent disk |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].portworxVolume +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].portworxVolume Description:: + -- @@ -10693,7 +10695,7 @@ Required:: | VolumeID uniquely identifies a Portworx volume |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected Description:: + -- @@ -10723,7 +10725,7 @@ Type:: | Projection that may be projected along with other supported volume types |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources Description:: + -- @@ -10736,7 +10738,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[] Description:: + -- @@ -10770,7 +10772,7 @@ Type:: | information about the serviceAccountToken data to project |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap Description:: + -- @@ -10804,7 +10806,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items Description:: + -- @@ -10817,7 +10819,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[] Description:: + -- @@ -10850,7 +10852,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI Description:: + -- @@ -10876,7 +10878,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items Description:: + -- @@ -10889,7 +10891,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[] Description:: + -- @@ -10925,7 +10927,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description:: + -- @@ -10953,7 +10955,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -10985,7 +10987,7 @@ Required:: | Required: resource to select |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret Description:: + -- @@ -11019,7 +11021,7 @@ Type:: | Specify whether the Secret or its key must be defined |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items Description:: + -- @@ -11032,7 +11034,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[] Description:: + -- @@ -11065,7 +11067,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken Description:: + -- @@ -11097,7 +11099,7 @@ Required:: | Path is the path relative to the mount point of the file to project the token into. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte Description:: + -- @@ -11142,7 +11144,7 @@ Required:: | Volume is a string that references an already created Quobyte volume by name. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].rbd +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd Description:: + -- @@ -11195,7 +11197,7 @@ Required:: | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef Description:: + -- @@ -11217,7 +11219,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO Description:: + -- @@ -11279,7 +11281,7 @@ Required:: | The name of a volume already created in the ScaleIO system that is associated with this volume source. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO.secretRef Description:: + -- @@ -11301,7 +11303,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].secret +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].secret Description:: + -- @@ -11339,7 +11341,7 @@ Type:: | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items Description:: + -- @@ -11352,7 +11354,7 @@ Type:: -..spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[] +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[] Description:: + -- @@ -11385,7 +11387,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].storageos +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos Description:: + -- @@ -11423,7 +11425,7 @@ Type:: | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].storageos.secretRef +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos.secretRef Description:: + -- @@ -11445,7 +11447,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.install.spec.deployments[].spec.template.spec.volumes[].vsphereVolume +=== .spec.install.spec.deployments[].spec.template.spec.volumes[].vsphereVolume Description:: + -- @@ -11481,7 +11483,7 @@ Required:: | Path that identifies vSphere volume vmdk |=== -..spec.install.spec.permissions +=== .spec.install.spec.permissions Description:: + -- @@ -11494,7 +11496,7 @@ Type:: -..spec.install.spec.permissions[] +=== .spec.install.spec.permissions[] Description:: + -- @@ -11527,7 +11529,7 @@ Required:: | |=== -..spec.install.spec.permissions[].rules +=== .spec.install.spec.permissions[].rules Description:: + -- @@ -11540,7 +11542,7 @@ Type:: -..spec.install.spec.permissions[].rules[] +=== .spec.install.spec.permissions[].rules[] Description:: + -- @@ -11580,7 +11582,7 @@ Required:: | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. '*' represents all verbs. |=== -..spec.installModes +=== .spec.installModes Description:: + -- @@ -11593,7 +11595,7 @@ Type:: -..spec.installModes[] +=== .spec.installModes[] Description:: + -- @@ -11622,7 +11624,7 @@ Required:: | InstallModeType is a supported type of install mode for CSV installation |=== -..spec.links +=== .spec.links Description:: + -- @@ -11635,7 +11637,7 @@ Type:: -..spec.links[] +=== .spec.links[] Description:: + -- @@ -11661,7 +11663,7 @@ Type:: | |=== -..spec.maintainers +=== .spec.maintainers Description:: + -- @@ -11674,7 +11676,7 @@ Type:: -..spec.maintainers[] +=== .spec.maintainers[] Description:: + -- @@ -11700,7 +11702,7 @@ Type:: | |=== -..spec.nativeAPIs +=== .spec.nativeAPIs Description:: + -- @@ -11713,7 +11715,7 @@ Type:: -..spec.nativeAPIs[] +=== .spec.nativeAPIs[] Description:: + -- @@ -11747,7 +11749,7 @@ Required:: | |=== -..spec.provider +=== .spec.provider Description:: + -- @@ -11773,7 +11775,7 @@ Type:: | |=== -..spec.relatedImages +=== .spec.relatedImages Description:: + -- @@ -11786,7 +11788,7 @@ Type:: -..spec.relatedImages[] +=== .spec.relatedImages[] Description:: + -- @@ -11815,7 +11817,7 @@ Required:: | |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -11845,7 +11847,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -11858,7 +11860,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -11891,7 +11893,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.webhookdefinitions +=== .spec.webhookdefinitions Description:: + -- @@ -11904,7 +11906,7 @@ Type:: -..spec.webhookdefinitions[] +=== .spec.webhookdefinitions[] Description:: + -- @@ -11991,7 +11993,7 @@ Required:: | |=== -..spec.webhookdefinitions[].objectSelector +=== .spec.webhookdefinitions[].objectSelector Description:: + -- @@ -12021,7 +12023,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.webhookdefinitions[].objectSelector.matchExpressions +=== .spec.webhookdefinitions[].objectSelector.matchExpressions Description:: + -- @@ -12034,7 +12036,7 @@ Type:: -..spec.webhookdefinitions[].objectSelector.matchExpressions[] +=== .spec.webhookdefinitions[].objectSelector.matchExpressions[] Description:: + -- @@ -12067,7 +12069,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.webhookdefinitions[].rules +=== .spec.webhookdefinitions[].rules Description:: + -- @@ -12080,7 +12082,7 @@ Type:: -..spec.webhookdefinitions[].rules[] +=== .spec.webhookdefinitions[].rules[] Description:: + -- @@ -12121,7 +12123,7 @@ Type:: | scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". |=== -..status +=== .status Description:: + -- @@ -12187,7 +12189,7 @@ Type:: | |=== -..status.cleanup +=== .status.cleanup Description:: + -- @@ -12213,7 +12215,7 @@ Type:: | ResourceList represents a list of resources which are of the same Group/Kind |=== -..status.cleanup.pendingDeletion +=== .status.cleanup.pendingDeletion Description:: + -- @@ -12226,7 +12228,7 @@ Type:: -..status.cleanup.pendingDeletion[] +=== .status.cleanup.pendingDeletion[] Description:: + -- @@ -12264,7 +12266,7 @@ Required:: | |=== -..status.cleanup.pendingDeletion[].instances +=== .status.cleanup.pendingDeletion[].instances Description:: + -- @@ -12277,7 +12279,7 @@ Type:: -..status.cleanup.pendingDeletion[].instances[] +=== .status.cleanup.pendingDeletion[].instances[] Description:: + -- @@ -12305,7 +12307,7 @@ Required:: | Namespace can be empty for cluster-scoped resources |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -12318,7 +12320,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -12356,7 +12358,7 @@ Type:: | A brief CamelCase message indicating details about why the ClusterServiceVersion is in this state. e.g. 'RequirementsNotMet' |=== -..status.requirementStatus +=== .status.requirementStatus Description:: + -- @@ -12369,7 +12371,7 @@ Type:: -..status.requirementStatus[] +=== .status.requirementStatus[] Description:: + -- @@ -12430,7 +12432,7 @@ Required:: | |=== -..status.requirementStatus[].dependents +=== .status.requirementStatus[].dependents Description:: + -- @@ -12443,7 +12445,7 @@ Type:: -..status.requirementStatus[].dependents[] +=== .status.requirementStatus[].dependents[] Description:: + -- @@ -12571,7 +12573,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterserviceversionlist-operators-coreos-com-v1alpha1[`ClusterServiceVersionList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.ClusterServiceVersionList[`ClusterServiceVersionList`] schema +| 401 - Unauthorized +| Empty |=== @@ -12649,7 +12653,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12706,7 +12712,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterserviceversionlist-operators-coreos-com-v1alpha1[`ClusterServiceVersionList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.ClusterServiceVersionList[`ClusterServiceVersionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12733,7 +12741,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema | |=== @@ -12742,7 +12750,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 201 - Created +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 202 - Accepted +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== @@ -12799,7 +12813,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -12808,7 +12822,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12835,7 +12853,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12862,7 +12882,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -12871,7 +12891,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12898,7 +12920,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema | |=== @@ -12907,7 +12929,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 201 - Created +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== @@ -12958,7 +12984,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -12985,7 +13013,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -12994,7 +13022,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -13021,7 +13051,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema | |=== @@ -13030,7 +13060,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 201 - Created +| xref:../operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc#clusterserviceversion-operators-coreos-com-v1alpha1[`ClusterServiceVersion`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc b/rest_api/operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc index a8bb83e6f2db..9e70821b54cf 100644 --- a/rest_api/operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc +++ b/rest_api/operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="installplan-operators-coreos-com-v1alpha1"] = InstallPlan [operators.coreos.com/v1alpha1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -49,7 +51,7 @@ Required:: Status may trail the actual state of a system. |=== -..spec +=== .spec Description:: + -- @@ -95,7 +97,7 @@ Required:: | |=== -..status +=== .status Description:: + -- @@ -161,7 +163,7 @@ Required:: | StartTime is the time when the controller began applying the resources listed in the plan to the cluster. |=== -..status.attenuatedServiceAccountRef +=== .status.attenuatedServiceAccountRef Description:: + -- @@ -207,7 +209,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.bundleLookups +=== .status.bundleLookups Description:: + -- @@ -220,7 +222,7 @@ Type:: -..status.bundleLookups[] +=== .status.bundleLookups[] Description:: + -- @@ -271,7 +273,7 @@ Required:: | Replaces is the name of the bundle to replace with the one found at Path. |=== -..status.bundleLookups[].catalogSourceRef +=== .status.bundleLookups[].catalogSourceRef Description:: + -- @@ -317,7 +319,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.bundleLookups[].conditions +=== .status.bundleLookups[].conditions Description:: + -- @@ -330,7 +332,7 @@ Type:: -..status.bundleLookups[].conditions[] +=== .status.bundleLookups[].conditions[] Description:: + -- @@ -375,7 +377,7 @@ Required:: | Type of condition. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -388,7 +390,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -430,7 +432,7 @@ Type:: | InstallPlanConditionType describes the state of an InstallPlan at a certain point as a whole. |=== -..status.plan +=== .status.plan Description:: + -- @@ -443,7 +445,7 @@ Type:: -..status.plan[] +=== .status.plan[] Description:: + -- @@ -477,7 +479,7 @@ Required:: | StepStatus is the current status of a particular resource an in InstallPlan |=== -..status.plan[].resource +=== .status.plan[].resource Description:: + -- @@ -611,7 +613,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#installplanlist-operators-coreos-com-v1alpha1[`InstallPlanList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.InstallPlanList[`InstallPlanList`] schema +| 401 - Unauthorized +| Empty |=== @@ -689,7 +693,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -746,7 +752,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#installplanlist-operators-coreos-com-v1alpha1[`InstallPlanList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.InstallPlanList[`InstallPlanList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -773,7 +781,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema | |=== @@ -782,7 +790,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 201 - Created +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 202 - Accepted +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== @@ -839,7 +853,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -848,7 +862,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -875,7 +893,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -902,7 +922,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -911,7 +931,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -938,7 +960,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema | |=== @@ -947,7 +969,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 201 - Created +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== @@ -998,7 +1024,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1025,7 +1053,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1034,7 +1062,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1061,7 +1091,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema | |=== @@ -1070,7 +1100,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 201 - Created +| xref:../operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc#installplan-operators-coreos-com-v1alpha1[`InstallPlan`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/operator-operators-coreos-com-v1.adoc b/rest_api/operatorhub_apis/operator-operators-coreos-com-v1.adoc index d8263ef530fa..ebe3e346471c 100644 --- a/rest_api/operatorhub_apis/operator-operators-coreos-com-v1.adoc +++ b/rest_api/operatorhub_apis/operator-operators-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operator-operators-coreos-com-v1"] = Operator [operators.coreos.com/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | OperatorStatus defines the observed state of an Operator and its components |=== -..spec +=== .spec Description:: + -- @@ -58,7 +60,7 @@ Type:: -..status +=== .status Description:: + -- @@ -80,7 +82,7 @@ Type:: | Components describes resources that compose the operator. |=== -..status.components +=== .status.components Description:: + -- @@ -112,7 +114,7 @@ Required:: | RichReference is a reference to a resource, enriched with its status conditions. |=== -..status.components.labelSelector +=== .status.components.labelSelector Description:: + -- @@ -142,7 +144,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..status.components.labelSelector.matchExpressions +=== .status.components.labelSelector.matchExpressions Description:: + -- @@ -155,7 +157,7 @@ Type:: -..status.components.labelSelector.matchExpressions[] +=== .status.components.labelSelector.matchExpressions[] Description:: + -- @@ -188,7 +190,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..status.components.refs +=== .status.components.refs Description:: + -- @@ -201,7 +203,7 @@ Type:: -..status.components.refs[] +=== .status.components.refs[] Description:: + -- @@ -255,7 +257,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.components.refs[].conditions +=== .status.components.refs[].conditions Description:: + -- @@ -268,7 +270,7 @@ Type:: -..status.components.refs[].conditions[] +=== .status.components.refs[].conditions[] Description:: + -- @@ -399,7 +401,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -456,7 +460,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorlist-operators-coreos-com-v1[`OperatorList operators.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.operators.v1.OperatorList[`OperatorList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -483,7 +489,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema | |=== @@ -492,7 +498,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 201 - Created +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 202 - Accepted +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== @@ -546,7 +558,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -555,7 +567,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -582,7 +598,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -609,7 +627,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -618,7 +636,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -645,7 +665,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema | |=== @@ -654,7 +674,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 201 - Created +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== @@ -702,7 +726,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -729,7 +755,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -738,7 +764,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -765,7 +793,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema | |=== @@ -774,7 +802,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator operators.coreos.com/v1`] +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 201 - Created +| xref:../operatorhub_apis/operator-operators-coreos-com-v1.adoc#operator-operators-coreos-com-v1[`Operator`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc b/rest_api/operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc index 8b9d5351b57b..8e6c8b824ea9 100644 --- a/rest_api/operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc +++ b/rest_api/operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operatorcondition-operators-coreos-com-v2"] = OperatorCondition [operators.coreos.com/v2] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | OperatorConditionStatus allows OLM to convey which conditions have been observed. |=== -..spec +=== .spec Description:: + -- @@ -91,7 +93,7 @@ Type:: | |=== -..spec.conditions +=== .spec.conditions Description:: + -- @@ -104,7 +106,7 @@ Type:: -..spec.conditions[] +=== .spec.conditions[] Description:: + -- @@ -153,7 +155,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..spec.overrides +=== .spec.overrides Description:: + -- @@ -166,7 +168,7 @@ Type:: -..spec.overrides[] +=== .spec.overrides[] Description:: + -- @@ -214,7 +216,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..status +=== .status Description:: + -- @@ -241,7 +243,7 @@ Type:: // other fields } |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -254,7 +256,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -384,7 +386,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorconditionlist-operators-coreos-com-v2[`OperatorConditionList operators.coreos.com/v2`] +| xref:../objects/index.adoc#com.coreos.operators.v2.OperatorConditionList[`OperatorConditionList`] schema +| 401 - Unauthorized +| Empty |=== @@ -462,7 +466,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -519,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorconditionlist-operators-coreos-com-v2[`OperatorConditionList operators.coreos.com/v2`] +| xref:../objects/index.adoc#com.coreos.operators.v2.OperatorConditionList[`OperatorConditionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -546,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema | |=== @@ -555,7 +563,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 202 - Accepted +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== @@ -612,7 +626,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -621,7 +635,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -648,7 +666,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -675,7 +695,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -684,7 +704,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -711,7 +733,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema | |=== @@ -720,7 +742,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== @@ -771,7 +797,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -798,7 +826,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -807,7 +835,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -834,7 +864,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema | |=== @@ -843,7 +873,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition operators.coreos.com/v2`] +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc#operatorcondition-operators-coreos-com-v2[`OperatorCondition`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc b/rest_api/operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc index a82fb3bdb832..00b8fa3de158 100644 --- a/rest_api/operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc +++ b/rest_api/operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operatorgroup-operators-coreos-com-v1"] = OperatorGroup [operators.coreos.com/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | OperatorGroupStatus is the status for an OperatorGroupResource. |=== -..spec +=== .spec Description:: + -- @@ -81,7 +83,7 @@ Type:: | TargetNamespaces is an explicit set of namespaces to target. If it is set, Selector is ignored. |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -111,7 +113,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.selector.matchExpressions +=== .spec.selector.matchExpressions Description:: + -- @@ -124,7 +126,7 @@ Type:: -..spec.selector.matchExpressions[] +=== .spec.selector.matchExpressions[] Description:: + -- @@ -157,7 +159,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..status +=== .status Description:: + -- @@ -198,7 +200,7 @@ Required:: | ServiceAccountRef references the service account object specified. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -211,7 +213,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -260,7 +262,7 @@ Required:: | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |=== -..status.serviceAccountRef +=== .status.serviceAccountRef Description:: + -- @@ -387,7 +389,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorgrouplist-operators-coreos-com-v1[`OperatorGroupList operators.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.operators.v1.OperatorGroupList[`OperatorGroupList`] schema +| 401 - Unauthorized +| Empty |=== @@ -465,7 +469,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -522,7 +528,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#operatorgrouplist-operators-coreos-com-v1[`OperatorGroupList operators.coreos.com/v1`] +| xref:../objects/index.adoc#com.coreos.operators.v1.OperatorGroupList[`OperatorGroupList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -549,7 +557,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema | |=== @@ -558,7 +566,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 202 - Accepted +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== @@ -615,7 +629,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -624,7 +638,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -651,7 +669,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -678,7 +698,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -687,7 +707,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -714,7 +736,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema | |=== @@ -723,7 +745,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== @@ -774,7 +800,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -801,7 +829,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -810,7 +838,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -837,7 +867,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema | |=== @@ -846,7 +876,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup operators.coreos.com/v1`] +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 201 - Created +| xref:../operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc#operatorgroup-operators-coreos-com-v1[`OperatorGroup`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/operatorhub_apis/operatorhub-apis-index.adoc b/rest_api/operatorhub_apis/operatorhub-apis-index.adoc index 3d60cad1dc42..0e44a87dfdbe 100644 --- a/rest_api/operatorhub_apis/operatorhub-apis-index.adoc +++ b/rest_api/operatorhub_apis/operatorhub-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="operatorhub-apis"] = OperatorHub APIs ifdef::product-title[] diff --git a/rest_api/operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc b/rest_api/operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc index 4a5f6fe21a08..f61713d44734 100644 --- a/rest_api/operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc +++ b/rest_api/operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="packagemanifest-packages-operators-coreos-com-v1"] = PackageManifest [packages.operators.coreos.com/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -45,7 +47,7 @@ Type:: | PackageManifestStatus represents the current status of the PackageManifest |=== -..spec +=== .spec Description:: + -- @@ -58,7 +60,7 @@ Type:: -..status +=== .status Description:: + -- @@ -121,7 +123,7 @@ Required:: | AppLink defines a link to an application |=== -..status.channels +=== .status.channels Description:: + -- @@ -134,7 +136,7 @@ Type:: -..status.channels[] +=== .status.channels[] Description:: + -- @@ -167,7 +169,7 @@ Required:: | Name is the name of the channel, e.g. `alpha` or `stable` |=== -..status.channels[].currentCSVDesc +=== .status.channels[].currentCSVDesc Description:: + -- @@ -189,1353 +191,79 @@ Type:: | | `apiservicedefinitions` -| `object` -| APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion. - -| `customresourcedefinitions` -| `object` -| CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. - -If the CRD is present in the Owned list, it is implicitly required. - -| `description` -| `string` -| LongDescription is the CSV's description - -| `displayName` -| `string` -| DisplayName is the CSV's display name - -| `icon` -| `array` -| Icon is the CSV's base64 encoded icon - -| `icon[]` -| `object` -| Icon defines a base64 encoded icon and media type - -| `installModes` -| `array` -| InstallModes specify supported installation types - -| `installModes[]` -| `object` -| InstallMode associates an InstallModeType with a flag representing if the CSV supports it - -| `keywords` -| `array (string)` -| - -| `links` -| `array` -| - -| `links[]` -| `object` -| AppLink defines a link to an application - -| `maintainers` -| `array` -| - -| `maintainers[]` -| `object` -| Maintainer defines a project maintainer - -| `maturity` -| `string` -| - -| `minKubeVersion` -| `string` -| Minimum Kubernetes version for operator installation - -| `nativeApis` -| xref:../objects/index.adoc#groupversionkind-meta-v1[`array (GroupVersionKind meta/v1)`] -| - -| `provider` -| `object` -| AppLink defines a link to an application - -| `relatedImages` -| `array (string)` -| List of related images - -| `version` -| `string` -| OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON. - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions -Description:: -+ --- -APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion. --- - -Type:: - `object` - - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `owned` -| `array` -| - -| `owned[]` -| `object` -| APIServiceDescription provides details to OLM about apis provided via aggregation - -| `required` -| `array` -| - -| `required[]` -| `object` -| APIServiceDescription provides details to OLM about apis provided via aggregation - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.owned -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[] -Description:: -+ --- -APIServiceDescription provides details to OLM about apis provided via aggregation --- - -Type:: - `object` - -Required:: - - `name` - - `group` - - `version` - - `kind` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `actionDescriptors` -| `array` -| - -| `actionDescriptors[]` -| `object` -| ActionDescriptor describes a declarative action that can be performed on a custom resource instance - -| `containerPort` -| `integer` -| - -| `deploymentName` -| `string` -| - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `group` -| `string` -| - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `resources` -| `array` -| - -| `resources[]` -| `object` -| APIResourceReference is a Kubernetes resource type used by a custom resource - -| `specDescriptors` -| `array` -| - -| `specDescriptors[]` -| `object` -| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it - -| `statusDescriptors` -| `array` -| - -| `statusDescriptors[]` -| `object` -| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].actionDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].actionDescriptors[] -Description:: -+ --- -ActionDescriptor describes a declarative action that can be performed on a custom resource instance --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].resources -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].resources[] -Description:: -+ --- -APIResourceReference is a Kubernetes resource type used by a custom resource --- - -Type:: - `object` - -Required:: - - `name` - - `kind` - - `version` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].specDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].specDescriptors[] -Description:: -+ --- -SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].statusDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.owned[].statusDescriptors[] -Description:: -+ --- -StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.required -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.required[] -Description:: -+ --- -APIServiceDescription provides details to OLM about apis provided via aggregation --- - -Type:: - `object` - -Required:: - - `name` - - `group` - - `version` - - `kind` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `actionDescriptors` -| `array` -| - -| `actionDescriptors[]` -| `object` -| ActionDescriptor describes a declarative action that can be performed on a custom resource instance - -| `containerPort` -| `integer` -| - -| `deploymentName` -| `string` -| - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `group` -| `string` -| - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `resources` -| `array` -| - -| `resources[]` -| `object` -| APIResourceReference is a Kubernetes resource type used by a custom resource - -| `specDescriptors` -| `array` -| - -| `specDescriptors[]` -| `object` -| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it - -| `statusDescriptors` -| `array` -| - -| `statusDescriptors[]` -| `object` -| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].actionDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].actionDescriptors[] -Description:: -+ --- -ActionDescriptor describes a declarative action that can be performed on a custom resource instance --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].resources -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].resources[] -Description:: -+ --- -APIResourceReference is a Kubernetes resource type used by a custom resource --- - -Type:: - `object` - -Required:: - - `name` - - `kind` - - `version` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].specDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].specDescriptors[] -Description:: -+ --- -SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].statusDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.apiservicedefinitions.required[].statusDescriptors[] -Description:: -+ --- -StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions -Description:: -+ --- -CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. - -If the CRD is present in the Owned list, it is implicitly required. --- - -Type:: - `object` - - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `owned` -| `array` -| - -| `owned[]` -| `object` -| CRDDescription provides details to OLM about the CRDs - -| `required` -| `array` -| - -| `required[]` -| `object` -| CRDDescription provides details to OLM about the CRDs - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.owned -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[] -Description:: -+ --- -CRDDescription provides details to OLM about the CRDs --- - -Type:: - `object` - -Required:: - - `name` - - `version` - - `kind` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `actionDescriptors` -| `array` -| - -| `actionDescriptors[]` -| `object` -| ActionDescriptor describes a declarative action that can be performed on a custom resource instance - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `resources` -| `array` -| - -| `resources[]` -| `object` -| APIResourceReference is a Kubernetes resource type used by a custom resource - -| `specDescriptors` -| `array` -| - -| `specDescriptors[]` -| `object` -| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it - -| `statusDescriptors` -| `array` -| - -| `statusDescriptors[]` -| `object` -| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].actionDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].actionDescriptors[] -Description:: -+ --- -ActionDescriptor describes a declarative action that can be performed on a custom resource instance --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].resources -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].resources[] -Description:: -+ --- -APIResourceReference is a Kubernetes resource type used by a custom resource --- - -Type:: - `object` - -Required:: - - `name` - - `kind` - - `version` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `version` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].specDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].specDescriptors[] -Description:: -+ --- -SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].statusDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.owned[].statusDescriptors[] -Description:: -+ --- -StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| - -| `x-descriptors` -| `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.required -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.required[] -Description:: -+ --- -CRDDescription provides details to OLM about the CRDs --- - -Type:: - `object` - -Required:: - - `name` - - `version` - - `kind` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `actionDescriptors` -| `array` -| - -| `actionDescriptors[]` -| `object` -| ActionDescriptor describes a declarative action that can be performed on a custom resource instance - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `kind` -| `string` -| - -| `name` -| `string` -| - -| `resources` -| `array` -| - -| `resources[]` -| `object` -| APIResourceReference is a Kubernetes resource type used by a custom resource - -| `specDescriptors` -| `array` -| - -| `specDescriptors[]` -| `object` -| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it - -| `statusDescriptors` -| `array` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.APIServiceDefinitions[`APIServiceDefinitions`] | -| `statusDescriptors[]` -| `object` -| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it - -| `version` -| `string` +| `customresourcedefinitions` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.CustomResourceDefinitions[`CustomResourceDefinitions`] | -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].actionDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].actionDescriptors[] -Description:: -+ --- -ActionDescriptor describes a declarative action that can be performed on a custom resource instance --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - | `description` | `string` -| +| LongDescription is the CSV's description | `displayName` | `string` -| +| DisplayName is the CSV's display name -| `path` -| `string` -| +| `icon` +| `array` +| Icon is the CSV's base64 encoded icon -| `value` -| `string` -| +| `icon[]` +| `object` +| Icon defines a base64 encoded icon and media type -| `x-descriptors` +| `installModes` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.operators.v1alpha1.InstallMode[`array (InstallMode)`] +| InstallModes specify supported installation types + +| `keywords` | `array (string)` | -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].resources -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].resources[] -Description:: -+ --- -APIResourceReference is a Kubernetes resource type used by a custom resource --- - -Type:: - `object` - -Required:: - - `name` - - `kind` - - `version` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `kind` -| `string` +| `links` +| `array` | -| `name` -| `string` -| +| `links[]` +| `object` +| AppLink defines a link to an application -| `version` -| `string` +| `maintainers` +| `array` | -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].specDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].specDescriptors[] -Description:: -+ --- -SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description +| `maintainers[]` +| `object` +| Maintainer defines a project maintainer -| `description` +| `maturity` | `string` | -| `displayName` +| `minKubeVersion` | `string` -| +| Minimum Kubernetes version for operator installation -| `path` -| `string` +| `nativeApis` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionKind[`array (GroupVersionKind)`] | -| `value` -| `string` -| +| `provider` +| `object` +| AppLink defines a link to an application -| `x-descriptors` +| `relatedImages` | `array (string)` -| - -|=== -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].statusDescriptors -Description:: -+ --- - --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.customresourcedefinitions.required[].statusDescriptors[] -Description:: -+ --- -StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it --- - -Type:: - `object` - -Required:: - - `path` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `description` -| `string` -| - -| `displayName` -| `string` -| - -| `path` -| `string` -| - -| `value` -| `string` -| +| List of related images -| `x-descriptors` -| `array (string)` -| +| `version` +| xref:../objects/index.adoc#com.github.operator-framework.api.pkg.lib.version.OperatorVersion[`OperatorVersion`] +| Version is the CSV's semantic version |=== -..status.channels[].currentCSVDesc.icon +=== .status.channels[].currentCSVDesc.icon Description:: + -- @@ -1548,7 +276,7 @@ Type:: -..status.channels[].currentCSVDesc.icon[] +=== .status.channels[].currentCSVDesc.icon[] Description:: + -- @@ -1574,49 +302,7 @@ Type:: | |=== -..status.channels[].currentCSVDesc.installModes -Description:: -+ --- -InstallModes specify supported installation types --- - -Type:: - `array` - - - - -..status.channels[].currentCSVDesc.installModes[] -Description:: -+ --- -InstallMode associates an InstallModeType with a flag representing if the CSV supports it --- - -Type:: - `object` - -Required:: - - `type` - - `supported` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `supported` -| `boolean` -| - -| `type` -| `string` -| - -|=== -..status.channels[].currentCSVDesc.links +=== .status.channels[].currentCSVDesc.links Description:: + -- @@ -1629,7 +315,7 @@ Type:: -..status.channels[].currentCSVDesc.links[] +=== .status.channels[].currentCSVDesc.links[] Description:: + -- @@ -1655,7 +341,7 @@ Type:: | |=== -..status.channels[].currentCSVDesc.maintainers +=== .status.channels[].currentCSVDesc.maintainers Description:: + -- @@ -1668,7 +354,7 @@ Type:: -..status.channels[].currentCSVDesc.maintainers[] +=== .status.channels[].currentCSVDesc.maintainers[] Description:: + -- @@ -1694,7 +380,7 @@ Type:: | |=== -..status.channels[].currentCSVDesc.provider +=== .status.channels[].currentCSVDesc.provider Description:: + -- @@ -1720,7 +406,7 @@ Type:: | |=== -..status.provider +=== .status.provider Description:: + -- @@ -1757,6 +443,8 @@ The following API endpoints are available: - `GET`: list objects of kind PackageManifest * `/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}` - `GET`: read the specified PackageManifest +* `/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon` +- `GET`: connect GET requests to icon of PackageManifest === /apis/packages.operators.coreos.com/v1/packagemanifests @@ -1818,7 +506,7 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#packagemanifestlist-packages-operators-coreos-com-v1[`PackageManifestList packages.operators.coreos.com/v1`] +| xref:../objects/index.adoc#com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifestList[`PackageManifestList`] schema |=== @@ -1889,7 +577,7 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#packagemanifestlist-packages-operators-coreos-com-v1[`PackageManifestList packages.operators.coreos.com/v1`] +| xref:../objects/index.adoc#com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifestList[`PackageManifestList`] schema |=== @@ -1928,7 +616,38 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`PackageManifest packages.operators.coreos.com/v1`] +| xref:../operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc#packagemanifest-packages-operators-coreos-com-v1[`PackageManifest`] schema +|=== + + +=== /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PackageManifest +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + + +HTTP method:: + `GET` + +Description:: + connect GET requests to icon of PackageManifest + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `string` |=== diff --git a/rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc b/rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc index 80e97bc841e4..4c3c1c80b1ff 100644 --- a/rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc +++ b/rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="subscription-operators-coreos-com-v1alpha1"] = Subscription [operators.coreos.com/v1alpha1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Required:: | |=== -..spec +=== .spec Description:: + -- @@ -98,7 +100,7 @@ Required:: | |=== -..spec.config +=== .spec.config Description:: + -- @@ -168,7 +170,7 @@ Type:: | Volume represents a named volume in a pod that may be accessed by any container in the pod. |=== -..spec.config.env +=== .spec.config.env Description:: + -- @@ -181,7 +183,7 @@ Type:: -..spec.config.env[] +=== .spec.config.env[] Description:: + -- @@ -213,7 +215,7 @@ Required:: | Source for the environment variable's value. Cannot be used if value is not empty. |=== -..spec.config.env[].valueFrom +=== .spec.config.env[].valueFrom Description:: + -- @@ -247,7 +249,7 @@ Type:: | Selects a key of a secret in the pod's namespace |=== -..spec.config.env[].valueFrom.configMapKeyRef +=== .spec.config.env[].valueFrom.configMapKeyRef Description:: + -- @@ -279,7 +281,7 @@ Required:: | Specify whether the ConfigMap or its key must be defined |=== -..spec.config.env[].valueFrom.fieldRef +=== .spec.config.env[].valueFrom.fieldRef Description:: + -- @@ -307,7 +309,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.config.env[].valueFrom.resourceFieldRef +=== .spec.config.env[].valueFrom.resourceFieldRef Description:: + -- @@ -339,7 +341,7 @@ Required:: | Required: resource to select |=== -..spec.config.env[].valueFrom.secretKeyRef +=== .spec.config.env[].valueFrom.secretKeyRef Description:: + -- @@ -371,7 +373,7 @@ Required:: | Specify whether the Secret or its key must be defined |=== -..spec.config.envFrom +=== .spec.config.envFrom Description:: + -- @@ -384,7 +386,7 @@ Type:: -..spec.config.envFrom[] +=== .spec.config.envFrom[] Description:: + -- @@ -414,7 +416,7 @@ Type:: | The Secret to select from |=== -..spec.config.envFrom[].configMapRef +=== .spec.config.envFrom[].configMapRef Description:: + -- @@ -440,7 +442,7 @@ Type:: | Specify whether the ConfigMap must be defined |=== -..spec.config.envFrom[].secretRef +=== .spec.config.envFrom[].secretRef Description:: + -- @@ -466,7 +468,7 @@ Type:: | Specify whether the Secret must be defined |=== -..spec.config.resources +=== .spec.config.resources Description:: + -- @@ -492,7 +494,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.config.selector +=== .spec.config.selector Description:: + -- @@ -522,7 +524,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.config.selector.matchExpressions +=== .spec.config.selector.matchExpressions Description:: + -- @@ -535,7 +537,7 @@ Type:: -..spec.config.selector.matchExpressions[] +=== .spec.config.selector.matchExpressions[] Description:: + -- @@ -568,7 +570,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.config.tolerations +=== .spec.config.tolerations Description:: + -- @@ -581,7 +583,7 @@ Type:: -..spec.config.tolerations[] +=== .spec.config.tolerations[] Description:: + -- @@ -619,7 +621,7 @@ Type:: | Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |=== -..spec.config.volumeMounts +=== .spec.config.volumeMounts Description:: + -- @@ -632,7 +634,7 @@ Type:: -..spec.config.volumeMounts[] +=== .spec.config.volumeMounts[] Description:: + -- @@ -677,7 +679,7 @@ Required:: | Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. |=== -..spec.config.volumes +=== .spec.config.volumes Description:: + -- @@ -690,7 +692,7 @@ Type:: -..spec.config.volumes[] +=== .spec.config.volumes[] Description:: + -- @@ -835,7 +837,7 @@ Required:: | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |=== -..spec.config.volumes[].awsElasticBlockStore +=== .spec.config.volumes[].awsElasticBlockStore Description:: + -- @@ -871,7 +873,7 @@ Required:: | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |=== -..spec.config.volumes[].azureDisk +=== .spec.config.volumes[].azureDisk Description:: + -- @@ -916,7 +918,7 @@ Required:: | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |=== -..spec.config.volumes[].azureFile +=== .spec.config.volumes[].azureFile Description:: + -- @@ -949,7 +951,7 @@ Required:: | Share Name |=== -..spec.config.volumes[].cephfs +=== .spec.config.volumes[].cephfs Description:: + -- @@ -993,7 +995,7 @@ Required:: | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |=== -..spec.config.volumes[].cephfs.secretRef +=== .spec.config.volumes[].cephfs.secretRef Description:: + -- @@ -1015,7 +1017,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].cinder +=== .spec.config.volumes[].cinder Description:: + -- @@ -1051,7 +1053,7 @@ Required:: | volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |=== -..spec.config.volumes[].cinder.secretRef +=== .spec.config.volumes[].cinder.secretRef Description:: + -- @@ -1073,7 +1075,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].configMap +=== .spec.config.volumes[].configMap Description:: + -- @@ -1111,7 +1113,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.config.volumes[].configMap.items +=== .spec.config.volumes[].configMap.items Description:: + -- @@ -1124,7 +1126,7 @@ Type:: -..spec.config.volumes[].configMap.items[] +=== .spec.config.volumes[].configMap.items[] Description:: + -- @@ -1157,7 +1159,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.config.volumes[].csi +=== .spec.config.volumes[].csi Description:: + -- @@ -1197,7 +1199,7 @@ Required:: | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. |=== -..spec.config.volumes[].csi.nodePublishSecretRef +=== .spec.config.volumes[].csi.nodePublishSecretRef Description:: + -- @@ -1219,7 +1221,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].downwardAPI +=== .spec.config.volumes[].downwardAPI Description:: + -- @@ -1249,7 +1251,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.config.volumes[].downwardAPI.items +=== .spec.config.volumes[].downwardAPI.items Description:: + -- @@ -1262,7 +1264,7 @@ Type:: -..spec.config.volumes[].downwardAPI.items[] +=== .spec.config.volumes[].downwardAPI.items[] Description:: + -- @@ -1298,7 +1300,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.config.volumes[].downwardAPI.items[].fieldRef +=== .spec.config.volumes[].downwardAPI.items[].fieldRef Description:: + -- @@ -1326,7 +1328,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.config.volumes[].downwardAPI.items[].resourceFieldRef +=== .spec.config.volumes[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -1358,7 +1360,7 @@ Required:: | Required: resource to select |=== -..spec.config.volumes[].emptyDir +=== .spec.config.volumes[].emptyDir Description:: + -- @@ -1384,7 +1386,7 @@ Type:: | Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |=== -..spec.config.volumes[].ephemeral +=== .spec.config.volumes[].ephemeral Description:: + -- @@ -1414,7 +1416,7 @@ Type:: Required, must not be nil. |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate Description:: + -- @@ -1445,7 +1447,7 @@ Required:: | The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.metadata +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.metadata Description:: + -- @@ -1458,7 +1460,7 @@ Type:: -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec Description:: + -- @@ -1508,7 +1510,7 @@ Type:: | VolumeName is the binding reference to the PersistentVolume backing this claim. |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource Description:: + -- @@ -1541,7 +1543,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef Description:: + -- @@ -1574,7 +1576,7 @@ Required:: | Name is the name of resource being referenced |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources Description:: + -- @@ -1600,7 +1602,7 @@ Type:: | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector Description:: + -- @@ -1630,7 +1632,7 @@ Type:: | matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |=== -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions Description:: + -- @@ -1643,7 +1645,7 @@ Type:: -..spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] +=== .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[] Description:: + -- @@ -1676,7 +1678,7 @@ Required:: | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.config.volumes[].fc +=== .spec.config.volumes[].fc Description:: + -- @@ -1714,7 +1716,7 @@ Type:: | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |=== -..spec.config.volumes[].flexVolume +=== .spec.config.volumes[].flexVolume Description:: + -- @@ -1754,7 +1756,7 @@ Required:: | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |=== -..spec.config.volumes[].flexVolume.secretRef +=== .spec.config.volumes[].flexVolume.secretRef Description:: + -- @@ -1776,7 +1778,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].flocker +=== .spec.config.volumes[].flocker Description:: + -- @@ -1802,7 +1804,7 @@ Type:: | UUID of the dataset. This is unique identifier of a Flocker dataset |=== -..spec.config.volumes[].gcePersistentDisk +=== .spec.config.volumes[].gcePersistentDisk Description:: + -- @@ -1838,7 +1840,7 @@ Required:: | ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |=== -..spec.config.volumes[].gitRepo +=== .spec.config.volumes[].gitRepo Description:: + -- @@ -1870,7 +1872,7 @@ Required:: | Commit hash for the specified revision. |=== -..spec.config.volumes[].glusterfs +=== .spec.config.volumes[].glusterfs Description:: + -- @@ -1903,7 +1905,7 @@ Required:: | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |=== -..spec.config.volumes[].hostPath +=== .spec.config.volumes[].hostPath Description:: + -- @@ -1931,7 +1933,7 @@ Required:: | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |=== -..spec.config.volumes[].iscsi +=== .spec.config.volumes[].iscsi Description:: + -- @@ -1997,7 +1999,7 @@ Required:: | iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |=== -..spec.config.volumes[].iscsi.secretRef +=== .spec.config.volumes[].iscsi.secretRef Description:: + -- @@ -2019,7 +2021,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].nfs +=== .spec.config.volumes[].nfs Description:: + -- @@ -2052,7 +2054,7 @@ Required:: | Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |=== -..spec.config.volumes[].persistentVolumeClaim +=== .spec.config.volumes[].persistentVolumeClaim Description:: + -- @@ -2080,7 +2082,7 @@ Required:: | Will force the ReadOnly setting in VolumeMounts. Default false. |=== -..spec.config.volumes[].photonPersistentDisk +=== .spec.config.volumes[].photonPersistentDisk Description:: + -- @@ -2108,7 +2110,7 @@ Required:: | ID that identifies Photon Controller persistent disk |=== -..spec.config.volumes[].portworxVolume +=== .spec.config.volumes[].portworxVolume Description:: + -- @@ -2140,7 +2142,7 @@ Required:: | VolumeID uniquely identifies a Portworx volume |=== -..spec.config.volumes[].projected +=== .spec.config.volumes[].projected Description:: + -- @@ -2170,7 +2172,7 @@ Type:: | Projection that may be projected along with other supported volume types |=== -..spec.config.volumes[].projected.sources +=== .spec.config.volumes[].projected.sources Description:: + -- @@ -2183,7 +2185,7 @@ Type:: -..spec.config.volumes[].projected.sources[] +=== .spec.config.volumes[].projected.sources[] Description:: + -- @@ -2217,7 +2219,7 @@ Type:: | information about the serviceAccountToken data to project |=== -..spec.config.volumes[].projected.sources[].configMap +=== .spec.config.volumes[].projected.sources[].configMap Description:: + -- @@ -2251,7 +2253,7 @@ Type:: | Specify whether the ConfigMap or its keys must be defined |=== -..spec.config.volumes[].projected.sources[].configMap.items +=== .spec.config.volumes[].projected.sources[].configMap.items Description:: + -- @@ -2264,7 +2266,7 @@ Type:: -..spec.config.volumes[].projected.sources[].configMap.items[] +=== .spec.config.volumes[].projected.sources[].configMap.items[] Description:: + -- @@ -2297,7 +2299,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.config.volumes[].projected.sources[].downwardAPI +=== .spec.config.volumes[].projected.sources[].downwardAPI Description:: + -- @@ -2323,7 +2325,7 @@ Type:: | DownwardAPIVolumeFile represents information to create the file containing the pod field |=== -..spec.config.volumes[].projected.sources[].downwardAPI.items +=== .spec.config.volumes[].projected.sources[].downwardAPI.items Description:: + -- @@ -2336,7 +2338,7 @@ Type:: -..spec.config.volumes[].projected.sources[].downwardAPI.items[] +=== .spec.config.volumes[].projected.sources[].downwardAPI.items[] Description:: + -- @@ -2372,7 +2374,7 @@ Required:: | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |=== -..spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef +=== .spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef Description:: + -- @@ -2400,7 +2402,7 @@ Required:: | Path of the field to select in the specified API version. |=== -..spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +=== .spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef Description:: + -- @@ -2432,7 +2434,7 @@ Required:: | Required: resource to select |=== -..spec.config.volumes[].projected.sources[].secret +=== .spec.config.volumes[].projected.sources[].secret Description:: + -- @@ -2466,7 +2468,7 @@ Type:: | Specify whether the Secret or its key must be defined |=== -..spec.config.volumes[].projected.sources[].secret.items +=== .spec.config.volumes[].projected.sources[].secret.items Description:: + -- @@ -2479,7 +2481,7 @@ Type:: -..spec.config.volumes[].projected.sources[].secret.items[] +=== .spec.config.volumes[].projected.sources[].secret.items[] Description:: + -- @@ -2512,7 +2514,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.config.volumes[].projected.sources[].serviceAccountToken +=== .spec.config.volumes[].projected.sources[].serviceAccountToken Description:: + -- @@ -2544,7 +2546,7 @@ Required:: | Path is the path relative to the mount point of the file to project the token into. |=== -..spec.config.volumes[].quobyte +=== .spec.config.volumes[].quobyte Description:: + -- @@ -2589,7 +2591,7 @@ Required:: | Volume is a string that references an already created Quobyte volume by name. |=== -..spec.config.volumes[].rbd +=== .spec.config.volumes[].rbd Description:: + -- @@ -2642,7 +2644,7 @@ Required:: | The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |=== -..spec.config.volumes[].rbd.secretRef +=== .spec.config.volumes[].rbd.secretRef Description:: + -- @@ -2664,7 +2666,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].scaleIO +=== .spec.config.volumes[].scaleIO Description:: + -- @@ -2726,7 +2728,7 @@ Required:: | The name of a volume already created in the ScaleIO system that is associated with this volume source. |=== -..spec.config.volumes[].scaleIO.secretRef +=== .spec.config.volumes[].scaleIO.secretRef Description:: + -- @@ -2748,7 +2750,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].secret +=== .spec.config.volumes[].secret Description:: + -- @@ -2786,7 +2788,7 @@ Type:: | Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |=== -..spec.config.volumes[].secret.items +=== .spec.config.volumes[].secret.items Description:: + -- @@ -2799,7 +2801,7 @@ Type:: -..spec.config.volumes[].secret.items[] +=== .spec.config.volumes[].secret.items[] Description:: + -- @@ -2832,7 +2834,7 @@ Required:: | The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |=== -..spec.config.volumes[].storageos +=== .spec.config.volumes[].storageos Description:: + -- @@ -2870,7 +2872,7 @@ Type:: | VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |=== -..spec.config.volumes[].storageos.secretRef +=== .spec.config.volumes[].storageos.secretRef Description:: + -- @@ -2892,7 +2894,7 @@ Type:: | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |=== -..spec.config.volumes[].vsphereVolume +=== .spec.config.volumes[].vsphereVolume Description:: + -- @@ -2928,7 +2930,7 @@ Required:: | Path that identifies vSphere volume vmdk |=== -..status +=== .status Description:: + -- @@ -2996,7 +2998,7 @@ Required:: | State represents the current state of the Subscription |=== -..status.catalogHealth +=== .status.catalogHealth Description:: + -- @@ -3009,7 +3011,7 @@ Type:: -..status.catalogHealth[] +=== .status.catalogHealth[] Description:: + -- @@ -3043,7 +3045,7 @@ Required:: | LastUpdated represents the last time that the CatalogSourceHealth changed |=== -..status.catalogHealth[].catalogSourceRef +=== .status.catalogHealth[].catalogSourceRef Description:: + -- @@ -3089,7 +3091,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -3102,7 +3104,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -3147,7 +3149,7 @@ Required:: | Type is the type of Subscription condition. |=== -..status.installPlanRef +=== .status.installPlanRef Description:: + -- @@ -3193,7 +3195,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status.installplan +=== .status.installplan Description:: + -- @@ -3313,7 +3315,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#subscriptionlist-operators-coreos-com-v1alpha1[`SubscriptionList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.SubscriptionList[`SubscriptionList`] schema +| 401 - Unauthorized +| Empty |=== @@ -3391,7 +3395,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3448,7 +3454,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#subscriptionlist-operators-coreos-com-v1alpha1[`SubscriptionList operators.coreos.com/v1alpha1`] +| xref:../objects/index.adoc#com.coreos.operators.v1alpha1.SubscriptionList[`SubscriptionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3475,7 +3483,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema | |=== @@ -3484,7 +3492,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 201 - Created +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 202 - Accepted +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== @@ -3541,7 +3555,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -3550,7 +3564,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3577,7 +3595,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3604,7 +3624,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -3613,7 +3633,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3640,7 +3662,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema | |=== @@ -3649,7 +3671,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 201 - Created +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== @@ -3700,7 +3726,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3727,7 +3755,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -3736,7 +3764,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -3763,7 +3793,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema | |=== @@ -3772,7 +3802,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription operators.coreos.com/v1alpha1`] +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 201 - Created +| xref:../operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc#subscription-operators-coreos-com-v1alpha1[`Subscription`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/metadata_apis/binding-core-v1.adoc b/rest_api/policy_apis/eviction-policy-v1.adoc similarity index 62% rename from rest_api/metadata_apis/binding-core-v1.adoc rename to rest_api/policy_apis/eviction-policy-v1.adoc index 3d546134d270..a7a82cbe3922 100644 --- a/rest_api/metadata_apis/binding-core-v1.adoc +++ b/rest_api/policy_apis/eviction-policy-v1.adoc @@ -1,5 +1,7 @@ -[id="binding-core-v1"] -= Binding [core/v1] +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="eviction-policy-v1"] += Eviction [policy/v1] ifdef::product-title[] include::modules/common-attributes.adoc[] endif::[] @@ -10,14 +12,12 @@ toc::[] Description:: + -- -Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. +Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. -- Type:: `object` -Required:: - - `target` == Specification @@ -30,17 +30,17 @@ Required:: | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +| `deleteOptions` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] +| DeleteOptions may be provided + | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - -| `target` -| xref:../objects/index.adoc#objectreference-core-v1[`ObjectReference core/v1`] -| The target object that you want to bind to the standard object. +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| ObjectMeta describes the pod that is being evicted. |=== @@ -48,16 +48,19 @@ Required:: The following API endpoints are available: -* `/api/v1/namespaces/{namespace}/bindings` -- `POST`: create a Binding +* `/api/v1/namespaces/{namespace}/pods/{name}/eviction` +- `POST`: create eviction of a Pod -=== /api/v1/namespaces/{namespace}/bindings +=== /api/v1/namespaces/{namespace}/pods/{name}/eviction .Global path parameters [cols="1,1,2",options="header"] |=== | Parameter | Type | Description +| `name` +| `string` +| name of the Eviction | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -82,7 +85,7 @@ HTTP method:: `POST` Description:: - create a Binding + create eviction of a Pod @@ -91,7 +94,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../metadata_apis/binding-core-v1.adoc#binding-core-v1[`Binding core/v1`] +| xref:../policy_apis/eviction-policy-v1.adoc#eviction-policy-v1[`Eviction`] schema | |=== @@ -100,7 +103,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../metadata_apis/binding-core-v1.adoc#binding-core-v1[`Binding core/v1`] +| xref:../policy_apis/eviction-policy-v1.adoc#eviction-policy-v1[`Eviction`] schema +| 201 - Created +| xref:../policy_apis/eviction-policy-v1.adoc#eviction-policy-v1[`Eviction`] schema +| 202 - Accepted +| xref:../policy_apis/eviction-policy-v1.adoc#eviction-policy-v1[`Eviction`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/policy_apis/poddisruptionbudget-policy-v1.adoc b/rest_api/policy_apis/poddisruptionbudget-policy-v1.adoc index b71c201ad043..7d6db62d5c4a 100644 --- a/rest_api/policy_apis/poddisruptionbudget-policy-v1.adoc +++ b/rest_api/policy_apis/poddisruptionbudget-policy-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="poddisruptionbudget-policy-v1"] = PodDisruptionBudget [policy/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system. |=== -..spec +=== .spec Description:: + -- @@ -63,19 +65,19 @@ Type:: | Property | Type | Description | `maxUnavailable` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | `minAvailable` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace. |=== -..status +=== .status Description:: + -- @@ -98,7 +100,7 @@ Required:: | Property | Type | Description | `conditions` -| xref:../objects/index.adoc#condition-meta-v1[`array (Condition meta/v1)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Condition[`array (Condition)`] | Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. @@ -118,7 +120,7 @@ Required:: | minimum desired number of healthy pods | `disruptedPods` -| xref:../objects/index.adoc#time-meta-v1[`object (Time meta/v1)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`object (Time)`] | DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions. | `disruptionsAllowed` @@ -141,15 +143,21 @@ The following API endpoints are available: * `/apis/policy/v1/poddisruptionbudgets` - `GET`: list or watch objects of kind PodDisruptionBudget +* `/apis/policy/v1/watch/poddisruptionbudgets` +- `GET`: watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets` - `DELETE`: delete collection of PodDisruptionBudget - `GET`: list or watch objects of kind PodDisruptionBudget - `POST`: create a PodDisruptionBudget +* `/apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets` +- `GET`: watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}` - `DELETE`: delete a PodDisruptionBudget - `GET`: read the specified PodDisruptionBudget - `PATCH`: partially update the specified PodDisruptionBudget - `PUT`: replace the specified PodDisruptionBudget +* `/apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}` +- `GET`: watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status` - `GET`: read status of the specified PodDisruptionBudget - `PATCH`: partially update status of the specified PodDisruptionBudget @@ -215,7 +223,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#poddisruptionbudgetlist-policy-v1[`PodDisruptionBudgetList policy/v1`] +| xref:../objects/index.adoc#io.k8s.api.policy.v1.PodDisruptionBudgetList[`PodDisruptionBudgetList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/policy/v1/watch/poddisruptionbudgets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -298,7 +373,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -307,7 +382,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -364,7 +441,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#poddisruptionbudgetlist-policy-v1[`PodDisruptionBudgetList policy/v1`] +| xref:../objects/index.adoc#io.k8s.api.policy.v1.PodDisruptionBudgetList[`PodDisruptionBudgetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -391,7 +470,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema | |=== @@ -400,7 +479,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 201 - Created +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 202 - Accepted +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -457,7 +615,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -466,7 +624,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -481,7 +643,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -511,7 +675,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -520,7 +684,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 201 - Created +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -547,7 +715,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema | |=== @@ -556,7 +724,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 201 - Created +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/policy/v1/watch/namespaces/{namespace}/poddisruptionbudgets/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PodDisruptionBudget +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -595,7 +843,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -625,7 +875,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -634,7 +884,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 201 - Created +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -661,7 +915,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema | |=== @@ -670,7 +924,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget policy/v1`] +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 201 - Created +| xref:../policy_apis/poddisruptionbudget-policy-v1.adoc#poddisruptionbudget-policy-v1[`PodDisruptionBudget`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/policy_apis/policy-apis-index.adoc b/rest_api/policy_apis/policy-apis-index.adoc index e5a805e9900b..5e11b22c97d9 100644 --- a/rest_api/policy_apis/policy-apis-index.adoc +++ b/rest_api/policy_apis/policy-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="policy-apis"] = Policy APIs ifdef::product-title[] @@ -6,6 +8,17 @@ endif::[] toc::[] +== Eviction [policy/v1] + +Description:: ++ +-- +Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. +-- + +Type:: + `object` + == PodDisruptionBudget [policy/v1] Description:: diff --git a/rest_api/project_apis/project-apis-index.adoc b/rest_api/project_apis/project-apis-index.adoc index c75a2cce7e3f..fb93d07f3753 100644 --- a/rest_api/project_apis/project-apis-index.adoc +++ b/rest_api/project_apis/project-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="project-apis"] = Project APIs ifdef::product-title[] @@ -31,3 +33,4 @@ ProjectRequest is the set of options necessary to fully qualify a project reques Type:: `object` + diff --git a/rest_api/project_apis/project-project-openshift-io-v1.adoc b/rest_api/project_apis/project-project-openshift-io-v1.adoc index 098de57fb66b..d83cd0e30b5f 100644 --- a/rest_api/project_apis/project-project-openshift-io-v1.adoc +++ b/rest_api/project_apis/project-project-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="project-project-openshift-io-v1"] = Project [project.openshift.io/v1] ifdef::product-title[] @@ -37,8 +39,8 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| | `spec` | `object` @@ -49,7 +51,7 @@ Type:: | ProjectStatus is information about the current status of a Project |=== -..spec +=== .spec Description:: + -- @@ -71,7 +73,7 @@ Type:: | Finalizers is an opaque list of values that must be empty to permanently remove object from storage |=== -..status +=== .status Description:: + -- @@ -89,7 +91,7 @@ Type:: | Property | Type | Description | `conditions` -| xref:../objects/index.adoc#namespacecondition-core-v1[`array (NamespaceCondition core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.NamespaceCondition[`array (NamespaceCondition)`] | Represents the latest available observations of the project current state. | `phase` @@ -105,11 +107,15 @@ The following API endpoints are available: * `/apis/project.openshift.io/v1/projects` - `GET`: list or watch objects of kind Project - `POST`: create a Project +* `/apis/project.openshift.io/v1/watch/projects` +- `GET`: watch individual changes to a list of Project. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/project.openshift.io/v1/projects/{name}` - `DELETE`: delete a Project - `GET`: read the specified Project - `PATCH`: partially update the specified Project - `PUT`: replace the specified Project +* `/apis/project.openshift.io/v1/watch/projects/{name}` +- `GET`: watch changes to an object of kind Project. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/project.openshift.io/v1/projects @@ -178,7 +184,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#projectlist-project-openshift-io-v1[`ProjectList project.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.project.v1.ProjectList[`ProjectList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -205,8 +213,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] -| +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| |=== .HTTP responses @@ -214,7 +222,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 201 - Created +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 202 - Accepted +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/project.openshift.io/v1/watch/projects + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Project. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -268,8 +347,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| |=== .HTTP responses @@ -277,7 +356,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -292,7 +375,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -322,8 +407,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -331,7 +416,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -358,14 +445,93 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] -| +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 201 - Created +| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project`] schema +| 401 - Unauthorized +| Empty |=== + +=== /apis/project.openshift.io/v1/watch/projects/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Project +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Project. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../project_apis/project-project-openshift-io-v1.adoc#project-project-openshift-io-v1[`Project project.openshift.io/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== + + diff --git a/rest_api/project_apis/projectrequest-project-openshift-io-v1.adoc b/rest_api/project_apis/projectrequest-project-openshift-io-v1.adoc index 89defa862bf4..8dda5253cac1 100644 --- a/rest_api/project_apis/projectrequest-project-openshift-io-v1.adoc +++ b/rest_api/project_apis/projectrequest-project-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="projectrequest-project-openshift-io-v1"] = ProjectRequest [project.openshift.io/v1] ifdef::product-title[] @@ -41,8 +43,8 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| |=== @@ -121,7 +123,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -148,8 +152,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest project.openshift.io/v1`] -| +| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest`] schema +| |=== .HTTP responses @@ -157,5 +161,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest project.openshift.io/v1`] +| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest`] schema +| 201 - Created +| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest`] schema +| 202 - Accepted +| xref:../project_apis/projectrequest-project-openshift-io-v1.adoc#projectrequest-project-openshift-io-v1[`ProjectRequest`] schema +| 401 - Unauthorized +| Empty |=== + + diff --git a/rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc b/rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc index 44dcd4bb242c..dfbde5d371c7 100644 --- a/rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc +++ b/rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="baremetalhost-metal3-io-v1alpha1"] = BareMetalHost [metal3.io/v1alpha1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | BareMetalHostStatus defines the observed state of BareMetalHost |=== -..spec +=== .spec Description:: + -- @@ -141,7 +143,7 @@ Required:: | UserData holds the reference to the Secret containing the user data to be passed to the host before it boots. |=== -..spec.bmc +=== .spec.bmc Description:: + -- @@ -174,7 +176,7 @@ Required:: | DisableCertificateVerification disables verification of server certificates when using HTTPS to connect to the BMC. This is required when the server certificate is self-signed, but is insecure because it allows a man-in-the-middle to intercept the connection. |=== -..spec.consumerRef +=== .spec.consumerRef Description:: + -- @@ -220,7 +222,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..spec.customDeploy +=== .spec.customDeploy Description:: + -- @@ -244,7 +246,7 @@ Required:: | Custom deploy method name. This name is specific to the deploy ramdisk used. If you don't have a custom deploy ramdisk, you shouldn't use CustomDeploy. |=== -..spec.firmware +=== .spec.firmware Description:: + -- @@ -274,7 +276,7 @@ Type:: | Supports the virtualization of platform hardware. This supports following options: true, false. |=== -..spec.image +=== .spec.image Description:: + -- @@ -310,7 +312,7 @@ Required:: | URL is a location of an image to deploy. |=== -..spec.metaData +=== .spec.metaData Description:: + -- @@ -336,7 +338,7 @@ Type:: | Namespace defines the space within which the secret name must be unique. |=== -..spec.networkData +=== .spec.networkData Description:: + -- @@ -362,7 +364,7 @@ Type:: | Namespace defines the space within which the secret name must be unique. |=== -..spec.raid +=== .spec.raid Description:: + -- @@ -380,196 +382,15 @@ Type:: | Property | Type | Description | `hardwareRAIDVolumes` -| `array` +| `` | The list of logical disks for hardware RAID, if rootDeviceHints isn't used, first volume is root volume. You can set the value of this field to `[]` to clear all the hardware RAID configurations. -| `hardwareRAIDVolumes[]` -| `object` -| HardwareRAIDVolume defines the desired configuration of volume in hardware RAID - | `softwareRAIDVolumes` -| `array` +| `` | The list of logical disks for software RAID, if rootDeviceHints isn't used, first volume is root volume. If HardwareRAIDVolumes is set this item will be invalid. The number of created Software RAID devices must be 1 or 2. If there is only one Software RAID device, it has to be a RAID-1. If there are two, the first one has to be a RAID-1, while the RAID level for the second one can be 0, 1, or 1+0. As the first RAID device will be the deployment device, enforcing a RAID-1 reduces the risk of ending up with a non-booting node in case of a disk failure. Software RAID will always be deleted. -| `softwareRAIDVolumes[]` -| `object` -| SoftwareRAIDVolume defines the desired configuration of volume in software RAID - -|=== -..spec.raid.hardwareRAIDVolumes -Description:: -+ --- -The list of logical disks for hardware RAID, if rootDeviceHints isn't used, first volume is root volume. You can set the value of this field to `[]` to clear all the hardware RAID configurations. --- - -Type:: - `array` - - - - -..spec.raid.hardwareRAIDVolumes[] -Description:: -+ --- -HardwareRAIDVolume defines the desired configuration of volume in hardware RAID --- - -Type:: - `object` - -Required:: - - `level` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `level` -| `string` -| RAID level for the logical disk. The following levels are supported: 0;1;2;5;6;1+0;5+0;6+0. - -| `name` -| `string` -| Name of the volume. Should be unique within the Node. If not specified, volume name will be auto-generated. - -| `numberOfPhysicalDisks` -| `integer` -| Integer, number of physical disks to use for the logical disk. Defaults to minimum number of disks required for the particular RAID level. - -| `rotational` -| `boolean` -| Select disks with only rotational or solid-state storage - -| `sizeGibibytes` -| `integer` -| Size (Integer) of the logical disk to be created in GiB. If unspecified or set be 0, the maximum capacity of disk will be used for logical disk. - -|=== -..spec.raid.softwareRAIDVolumes -Description:: -+ --- -The list of logical disks for software RAID, if rootDeviceHints isn't used, first volume is root volume. If HardwareRAIDVolumes is set this item will be invalid. The number of created Software RAID devices must be 1 or 2. If there is only one Software RAID device, it has to be a RAID-1. If there are two, the first one has to be a RAID-1, while the RAID level for the second one can be 0, 1, or 1+0. As the first RAID device will be the deployment device, enforcing a RAID-1 reduces the risk of ending up with a non-booting node in case of a disk failure. Software RAID will always be deleted. --- - -Type:: - `array` - - - - -..spec.raid.softwareRAIDVolumes[] -Description:: -+ --- -SoftwareRAIDVolume defines the desired configuration of volume in software RAID --- - -Type:: - `object` - -Required:: - - `level` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `level` -| `string` -| RAID level for the logical disk. The following levels are supported: 0;1;1+0. - -| `physicalDisks` -| `array` -| A list of device hints, the number of items should be greater than or equal to 2. - -| `physicalDisks[]` -| `object` -| RootDeviceHints holds the hints for specifying the storage location for the root filesystem for the image. - -| `sizeGibibytes` -| `integer` -| Size (Integer) of the logical disk to be created in GiB. If unspecified or set be 0, the maximum capacity of disk will be used for logical disk. - -|=== -..spec.raid.softwareRAIDVolumes[].physicalDisks -Description:: -+ --- -A list of device hints, the number of items should be greater than or equal to 2. --- - -Type:: - `array` - - - - -..spec.raid.softwareRAIDVolumes[].physicalDisks[] -Description:: -+ --- -RootDeviceHints holds the hints for specifying the storage location for the root filesystem for the image. --- - -Type:: - `object` - - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `deviceName` -| `string` -| A Linux device name like "/dev/vda". The hint must match the actual value exactly. - -| `hctl` -| `string` -| A SCSI bus address like 0:0:0:0. The hint must match the actual value exactly. - -| `minSizeGigabytes` -| `integer` -| The minimum size of the device in Gigabytes. - -| `model` -| `string` -| A vendor-specific device identifier. The hint can be a substring of the actual value. - -| `rotational` -| `boolean` -| True if the device should use spinning media, false otherwise. - -| `serialNumber` -| `string` -| Device serial number. The hint must match the actual value exactly. - -| `vendor` -| `string` -| The name of the vendor or manufacturer of the device. The hint can be a substring of the actual value. - -| `wwn` -| `string` -| Unique storage identifier. The hint must match the actual value exactly. - -| `wwnVendorExtension` -| `string` -| Unique vendor storage identifier. The hint must match the actual value exactly. - -| `wwnWithExtension` -| `string` -| Unique storage identifier with the vendor extension appended. The hint must match the actual value exactly. - |=== -..spec.rootDeviceHints +=== .spec.rootDeviceHints Description:: + -- @@ -627,7 +448,7 @@ Type:: | Unique storage identifier with the vendor extension appended. The hint must match the actual value exactly. |=== -..spec.taints +=== .spec.taints Description:: + -- @@ -640,7 +461,7 @@ Type:: -..spec.taints[] +=== .spec.taints[] Description:: + -- @@ -677,7 +498,7 @@ Required:: | The taint value corresponding to the taint key. |=== -..spec.userData +=== .spec.userData Description:: + -- @@ -703,7 +524,7 @@ Type:: | Namespace defines the space within which the secret name must be unique. |=== -..status +=== .status Description:: + -- @@ -776,7 +597,7 @@ Required:: | the last credentials we sent to the provisioning backend |=== -..status.goodCredentials +=== .status.goodCredentials Description:: + -- @@ -799,10 +620,10 @@ Type:: | `credentialsVersion` | `string` -| +| |=== -..status.goodCredentials.credentials +=== .status.goodCredentials.credentials Description:: + -- @@ -828,7 +649,7 @@ Type:: | Namespace defines the space within which the secret name must be unique. |=== -..status.hardware +=== .status.hardware Description:: + -- @@ -855,11 +676,11 @@ Type:: | `hostname` | `string` -| +| | `nics` | `array` -| +| | `nics[]` | `object` @@ -867,11 +688,11 @@ Type:: | `ramMebibytes` | `integer` -| +| | `storage` | `array` -| +| | `storage[]` | `object` @@ -882,7 +703,7 @@ Type:: | HardwareSystemVendor stores details about the whole hardware system. |=== -..status.hardware.cpu +=== .status.hardware.cpu Description:: + -- @@ -901,7 +722,7 @@ Type:: | `arch` | `string` -| +| | `clockMegahertz` | `number` @@ -909,18 +730,18 @@ Type:: | `count` | `integer` -| +| | `flags` | `array (string)` -| +| | `model` | `string` -| +| |=== -..status.hardware.firmware +=== .status.hardware.firmware Description:: + -- @@ -942,7 +763,7 @@ Type:: | The BIOS for this firmware |=== -..status.hardware.firmware.bios +=== .status.hardware.firmware.bios Description:: + -- @@ -972,7 +793,7 @@ Type:: | The version of the BIOS |=== -..status.hardware.nics +=== .status.hardware.nics Description:: + -- @@ -985,7 +806,7 @@ Type:: -..status.hardware.nics[] +=== .status.hardware.nics[] Description:: + -- @@ -1039,7 +860,7 @@ Type:: | VLAN represents the name and ID of a VLAN |=== -..status.hardware.nics[].vlans +=== .status.hardware.nics[].vlans Description:: + -- @@ -1052,7 +873,7 @@ Type:: -..status.hardware.nics[].vlans[] +=== .status.hardware.nics[].vlans[] Description:: + -- @@ -1075,10 +896,10 @@ Type:: | `name` | `string` -| +| |=== -..status.hardware.storage +=== .status.hardware.storage Description:: + -- @@ -1091,7 +912,7 @@ Type:: -..status.hardware.storage[] +=== .status.hardware.storage[] Description:: + -- @@ -1153,7 +974,7 @@ Type:: | The WWN with the extension |=== -..status.hardware.systemVendor +=== .status.hardware.systemVendor Description:: + -- @@ -1172,18 +993,18 @@ Type:: | `manufacturer` | `string` -| +| | `productName` | `string` -| +| | `serialNumber` | `string` -| +| |=== -..status.operationHistory +=== .status.operationHistory Description:: + -- @@ -1217,7 +1038,7 @@ Type:: | OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics. |=== -..status.operationHistory.deprovision +=== .status.operationHistory.deprovision Description:: + -- @@ -1236,14 +1057,14 @@ Type:: | `end` | `` -| +| | `start` | `` -| +| |=== -..status.operationHistory.inspect +=== .status.operationHistory.inspect Description:: + -- @@ -1262,14 +1083,14 @@ Type:: | `end` | `` -| +| | `start` | `` -| +| |=== -..status.operationHistory.provision +=== .status.operationHistory.provision Description:: + -- @@ -1288,14 +1109,14 @@ Type:: | `end` | `` -| +| | `start` | `` -| +| |=== -..status.operationHistory.register +=== .status.operationHistory.register Description:: + -- @@ -1314,14 +1135,14 @@ Type:: | `end` | `` -| +| | `start` | `` -| +| |=== -..status.provisioning +=== .status.provisioning Description:: + -- @@ -1374,7 +1195,7 @@ Required:: | An indiciator for what the provisioner is doing with the host. |=== -..status.provisioning.customDeploy +=== .status.provisioning.customDeploy Description:: + -- @@ -1398,7 +1219,7 @@ Required:: | Custom deploy method name. This name is specific to the deploy ramdisk used. If you don't have a custom deploy ramdisk, you shouldn't use CustomDeploy. |=== -..status.provisioning.firmware +=== .status.provisioning.firmware Description:: + -- @@ -1428,7 +1249,7 @@ Type:: | Supports the virtualization of platform hardware. This supports following options: true, false. |=== -..status.provisioning.image +=== .status.provisioning.image Description:: + -- @@ -1464,7 +1285,7 @@ Required:: | URL is a location of an image to deploy. |=== -..status.provisioning.raid +=== .status.provisioning.raid Description:: + -- @@ -1482,196 +1303,15 @@ Type:: | Property | Type | Description | `hardwareRAIDVolumes` -| `array` +| `` | The list of logical disks for hardware RAID, if rootDeviceHints isn't used, first volume is root volume. You can set the value of this field to `[]` to clear all the hardware RAID configurations. -| `hardwareRAIDVolumes[]` -| `object` -| HardwareRAIDVolume defines the desired configuration of volume in hardware RAID - | `softwareRAIDVolumes` -| `array` +| `` | The list of logical disks for software RAID, if rootDeviceHints isn't used, first volume is root volume. If HardwareRAIDVolumes is set this item will be invalid. The number of created Software RAID devices must be 1 or 2. If there is only one Software RAID device, it has to be a RAID-1. If there are two, the first one has to be a RAID-1, while the RAID level for the second one can be 0, 1, or 1+0. As the first RAID device will be the deployment device, enforcing a RAID-1 reduces the risk of ending up with a non-booting node in case of a disk failure. Software RAID will always be deleted. -| `softwareRAIDVolumes[]` -| `object` -| SoftwareRAIDVolume defines the desired configuration of volume in software RAID - -|=== -..status.provisioning.raid.hardwareRAIDVolumes -Description:: -+ --- -The list of logical disks for hardware RAID, if rootDeviceHints isn't used, first volume is root volume. You can set the value of this field to `[]` to clear all the hardware RAID configurations. --- - -Type:: - `array` - - - - -..status.provisioning.raid.hardwareRAIDVolumes[] -Description:: -+ --- -HardwareRAIDVolume defines the desired configuration of volume in hardware RAID --- - -Type:: - `object` - -Required:: - - `level` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `level` -| `string` -| RAID level for the logical disk. The following levels are supported: 0;1;2;5;6;1+0;5+0;6+0. - -| `name` -| `string` -| Name of the volume. Should be unique within the Node. If not specified, volume name will be auto-generated. - -| `numberOfPhysicalDisks` -| `integer` -| Integer, number of physical disks to use for the logical disk. Defaults to minimum number of disks required for the particular RAID level. - -| `rotational` -| `boolean` -| Select disks with only rotational or solid-state storage - -| `sizeGibibytes` -| `integer` -| Size (Integer) of the logical disk to be created in GiB. If unspecified or set be 0, the maximum capacity of disk will be used for logical disk. - -|=== -..status.provisioning.raid.softwareRAIDVolumes -Description:: -+ --- -The list of logical disks for software RAID, if rootDeviceHints isn't used, first volume is root volume. If HardwareRAIDVolumes is set this item will be invalid. The number of created Software RAID devices must be 1 or 2. If there is only one Software RAID device, it has to be a RAID-1. If there are two, the first one has to be a RAID-1, while the RAID level for the second one can be 0, 1, or 1+0. As the first RAID device will be the deployment device, enforcing a RAID-1 reduces the risk of ending up with a non-booting node in case of a disk failure. Software RAID will always be deleted. --- - -Type:: - `array` - - - - -..status.provisioning.raid.softwareRAIDVolumes[] -Description:: -+ --- -SoftwareRAIDVolume defines the desired configuration of volume in software RAID --- - -Type:: - `object` - -Required:: - - `level` - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `level` -| `string` -| RAID level for the logical disk. The following levels are supported: 0;1;1+0. - -| `physicalDisks` -| `array` -| A list of device hints, the number of items should be greater than or equal to 2. - -| `physicalDisks[]` -| `object` -| RootDeviceHints holds the hints for specifying the storage location for the root filesystem for the image. - -| `sizeGibibytes` -| `integer` -| Size (Integer) of the logical disk to be created in GiB. If unspecified or set be 0, the maximum capacity of disk will be used for logical disk. - -|=== -..status.provisioning.raid.softwareRAIDVolumes[].physicalDisks -Description:: -+ --- -A list of device hints, the number of items should be greater than or equal to 2. --- - -Type:: - `array` - - - - -..status.provisioning.raid.softwareRAIDVolumes[].physicalDisks[] -Description:: -+ --- -RootDeviceHints holds the hints for specifying the storage location for the root filesystem for the image. --- - -Type:: - `object` - - - - -[cols="1,1,1",options="header"] -|=== -| Property | Type | Description - -| `deviceName` -| `string` -| A Linux device name like "/dev/vda". The hint must match the actual value exactly. - -| `hctl` -| `string` -| A SCSI bus address like 0:0:0:0. The hint must match the actual value exactly. - -| `minSizeGigabytes` -| `integer` -| The minimum size of the device in Gigabytes. - -| `model` -| `string` -| A vendor-specific device identifier. The hint can be a substring of the actual value. - -| `rotational` -| `boolean` -| True if the device should use spinning media, false otherwise. - -| `serialNumber` -| `string` -| Device serial number. The hint must match the actual value exactly. - -| `vendor` -| `string` -| The name of the vendor or manufacturer of the device. The hint can be a substring of the actual value. - -| `wwn` -| `string` -| Unique storage identifier. The hint must match the actual value exactly. - -| `wwnVendorExtension` -| `string` -| Unique vendor storage identifier. The hint must match the actual value exactly. - -| `wwnWithExtension` -| `string` -| Unique storage identifier with the vendor extension appended. The hint must match the actual value exactly. - |=== -..status.provisioning.rootDeviceHints +=== .status.provisioning.rootDeviceHints Description:: + -- @@ -1729,7 +1369,7 @@ Type:: | Unique storage identifier with the vendor extension appended. The hint must match the actual value exactly. |=== -..status.triedCredentials +=== .status.triedCredentials Description:: + -- @@ -1752,10 +1392,10 @@ Type:: | `credentialsVersion` | `string` -| +| |=== -..status.triedCredentials.credentials +=== .status.triedCredentials.credentials Description:: + -- @@ -1862,7 +1502,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#baremetalhostlist-metal3-io-v1alpha1[`BareMetalHostList metal3.io/v1alpha1`] +| xref:../objects/index.adoc#io.metal3.v1alpha1.BareMetalHostList[`BareMetalHostList`] schema +| 401 - Unauthorized +| Empty |=== @@ -1940,7 +1582,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1997,7 +1641,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#baremetalhostlist-metal3-io-v1alpha1[`BareMetalHostList metal3.io/v1alpha1`] +| xref:../objects/index.adoc#io.metal3.v1alpha1.BareMetalHostList[`BareMetalHostList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2024,8 +1670,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| |=== .HTTP responses @@ -2033,7 +1679,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 201 - Created +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 202 - Accepted +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== @@ -2090,8 +1742,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| |=== .HTTP responses @@ -2099,7 +1751,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2126,7 +1782,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2153,8 +1811,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -2162,7 +1820,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2189,8 +1849,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| |=== .HTTP responses @@ -2198,7 +1858,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 201 - Created +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== @@ -2249,7 +1913,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2276,8 +1942,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -2285,7 +1951,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2312,8 +1980,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| |=== .HTTP responses @@ -2321,5 +1989,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost metal3.io/v1alpha1`] +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 201 - Created +| xref:../provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc#baremetalhost-metal3-io-v1alpha1[`BareMetalHost`] schema +| 401 - Unauthorized +| Empty |=== + + diff --git a/rest_api/provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc b/rest_api/provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc new file mode 100644 index 000000000000..0498328fc9ff --- /dev/null +++ b/rest_api/provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc @@ -0,0 +1,589 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="firmwareschema-metal3-io-v1alpha1"] += FirmwareSchema [metal3.io/v1alpha1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +FirmwareSchema is the Schema for the firmwareschemas API +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| FirmwareSchemaSpec defines the desired state of FirmwareSchema + +|=== +=== .spec +Description:: ++ +-- +FirmwareSchemaSpec defines the desired state of FirmwareSchema +-- + +Type:: + `object` + +Required:: + - `schema` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hardwareModel` +| `string` +| The hardware model associated with this schema + +| `hardwareVendor` +| `string` +| The hardware vendor associated with this schema + +| `schema` +| `object` +| Map of firmware name to schema + +| `schema{}` +| `object` +| Additional data describing the firmware setting + +|=== +=== .spec.schema +Description:: ++ +-- +Map of firmware name to schema +-- + +Type:: + `object` + + + + +=== .spec.schema{} +Description:: ++ +-- +Additional data describing the firmware setting +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowable_values` +| `array (string)` +| The allowable value for an Enumeration type setting. + +| `attribute_type` +| `string` +| The type of setting. + +| `lower_bound` +| `integer` +| The lowest value for an Integer type setting. + +| `max_length` +| `integer` +| Maximum length for a String type setting. + +| `min_length` +| `integer` +| Minimum length for a String type setting. + +| `read_only` +| `boolean` +| Whether or not this setting is read only. + +| `reset_required` +| `boolean` +| Whether or not a reset is required after changing this setting. + +| `unique` +| `boolean` +| Whether or not this setting's value is unique to this node, e.g. a serial number. + +| `upper_bound` +| `integer` +| The highest value for an Integer type setting. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/metal3.io/v1alpha1/firmwareschemas` +- `GET`: list objects of kind FirmwareSchema +* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas` +- `DELETE`: delete collection of FirmwareSchema +- `GET`: list objects of kind FirmwareSchema +- `POST`: create a FirmwareSchema +* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}` +- `DELETE`: delete a FirmwareSchema +- `GET`: read the specified FirmwareSchema +- `PATCH`: partially update the specified FirmwareSchema +- `PUT`: replace the specified FirmwareSchema + + +=== /apis/metal3.io/v1alpha1/firmwareschemas + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind FirmwareSchema + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.metal3.v1alpha1.FirmwareSchemaList[`FirmwareSchemaList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.metal3.v1alpha1.FirmwareSchemaList[`FirmwareSchemaList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 201 - Created +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 202 - Accepted +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the FirmwareSchema +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified FirmwareSchema + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 201 - Created +| xref:../provisioning_apis/firmwareschema-metal3-io-v1alpha1.adoc#firmwareschema-metal3-io-v1alpha1[`FirmwareSchema`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc b/rest_api/provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc new file mode 100644 index 000000000000..59b9e764524b --- /dev/null +++ b/rest_api/provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc @@ -0,0 +1,777 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="hostfirmwaresettings-metal3-io-v1alpha1"] += HostFirmwareSettings [metal3.io/v1alpha1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +HostFirmwareSettings is the Schema for the hostfirmwaresettings API +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| HostFirmwareSettingsSpec defines the desired state of HostFirmwareSettings + +| `status` +| `object` +| HostFirmwareSettingsStatus defines the observed state of HostFirmwareSettings + +|=== +=== .spec +Description:: ++ +-- +HostFirmwareSettingsSpec defines the desired state of HostFirmwareSettings +-- + +Type:: + `object` + +Required:: + - `settings` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `settings` +| `integer-or-string` +| Settings are the desired firmware settings stored as name/value pairs. This will be populated with the actual firmware settings and only contain the settings that can be modified (i.e. not ReadOnly), to facilitate making changes. + +|=== +=== .status +Description:: ++ +-- +HostFirmwareSettingsStatus defines the observed state of HostFirmwareSettings +-- + +Type:: + `object` + +Required:: + - `settings` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditions` +| `array` +| Track whether settings stored in the spec are valid based on the schema + +| `conditions[]` +| `object` +| Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` + // other fields } + +| `schema` +| `object` +| FirmwareSchema is a reference to the Schema used to describe each FirmwareSetting. By default, this will be a Schema in the same Namespace as the settings but it can be overwritten in the Spec + +| `settings` +| `object (string)` +| Settings are the actual firmware settings stored as name/value pairs + +|=== +=== .status.conditions +Description:: ++ +-- +Track whether settings stored in the spec are valid based on the schema +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` + // other fields } +-- + +Type:: + `object` + +Required:: + - `lastTransitionTime` + - `message` + - `reason` + - `status` + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastTransitionTime` +| `string` +| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. + +| `message` +| `string` +| message is a human readable message indicating details about the transition. This may be an empty string. + +| `observedGeneration` +| `integer` +| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. + +| `reason` +| `string` +| reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. + +| `status` +| `string` +| status of the condition, one of True, False, Unknown. + +| `type` +| `string` +| type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + +|=== +=== .status.schema +Description:: ++ +-- +FirmwareSchema is a reference to the Schema used to describe each FirmwareSetting. By default, this will be a Schema in the same Namespace as the settings but it can be overwritten in the Spec +-- + +Type:: + `object` + +Required:: + - `name` + - `namespace` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| `name` is the reference to the schema. + +| `namespace` +| `string` +| `namespace` is the namespace of the where the schema is stored. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/metal3.io/v1alpha1/hostfirmwaresettings` +- `GET`: list objects of kind HostFirmwareSettings +* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings` +- `DELETE`: delete collection of HostFirmwareSettings +- `GET`: list objects of kind HostFirmwareSettings +- `POST`: create HostFirmwareSettings +* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}` +- `DELETE`: delete HostFirmwareSettings +- `GET`: read the specified HostFirmwareSettings +- `PATCH`: partially update the specified HostFirmwareSettings +- `PUT`: replace the specified HostFirmwareSettings +* `/apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status` +- `GET`: read status of the specified HostFirmwareSettings +- `PATCH`: partially update status of the specified HostFirmwareSettings +- `PUT`: replace status of the specified HostFirmwareSettings + + +=== /apis/metal3.io/v1alpha1/hostfirmwaresettings + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind HostFirmwareSettings + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.metal3.v1alpha1.HostFirmwareSettingsList[`HostFirmwareSettingsList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.metal3.v1alpha1.HostFirmwareSettingsList[`HostFirmwareSettingsList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 201 - Created +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 202 - Accepted +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the HostFirmwareSettings +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 201 - Created +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the HostFirmwareSettings +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified HostFirmwareSettings + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 201 - Created +| xref:../provisioning_apis/hostfirmwaresettings-metal3-io-v1alpha1.adoc#hostfirmwaresettings-metal3-io-v1alpha1[`HostFirmwareSettings`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/provisioning_apis/provisioning-apis-index.adoc b/rest_api/provisioning_apis/provisioning-apis-index.adoc index 9f6b5c7ab6aa..c9061c100673 100644 --- a/rest_api/provisioning_apis/provisioning-apis-index.adoc +++ b/rest_api/provisioning_apis/provisioning-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="provisioning-apis"] = Provisioning APIs ifdef::product-title[] @@ -14,6 +16,28 @@ Description:: BareMetalHost is the Schema for the baremetalhosts API -- +Type:: + `object` + +== FirmwareSchema [metal3.io/v1alpha1] + +Description:: ++ +-- +FirmwareSchema is the Schema for the firmwareschemas API +-- + +Type:: + `object` + +== HostFirmwareSettings [metal3.io/v1alpha1] + +Description:: ++ +-- +HostFirmwareSettings is the Schema for the hostfirmwaresettings API +-- + Type:: `object` @@ -27,3 +51,4 @@ Provisioning contains configuration used by the Provisioning service (Ironic) to Type:: `object` + diff --git a/rest_api/provisioning_apis/provisioning-metal3-io-v1alpha1.adoc b/rest_api/provisioning_apis/provisioning-metal3-io-v1alpha1.adoc index 285aa9443603..846468dbd9e0 100644 --- a/rest_api/provisioning_apis/provisioning-metal3-io-v1alpha1.adoc +++ b/rest_api/provisioning_apis/provisioning-metal3-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="provisioning-metal3-io-v1alpha1"] = Provisioning [metal3.io/v1alpha1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | ProvisioningStatus defines the observed state of Provisioning |=== -..spec +=== .spec Description:: + -- @@ -86,6 +88,10 @@ Type:: | `string` | ProvisioningInterface is the name of the network interface on a baremetal server to the provisioning network. It can have values like eth1 or ens3. +| `provisioningMacAddresses` +| `array (string)` +| ProvisioningMacAddresses is a list of mac addresses of network interfaces on a baremetal server to the provisioning network. Use this instead of ProvisioningInterface to allow interfaces of different names. If not provided it will be populated by the BMH.Spec.BootMacAddress of each master. + | `provisioningNetwork` | `string` | ProvisioningNetwork provides a way to indicate the state of the underlying network configuration for the provisioning network. This field can have one of the following values - `Managed`- when the provisioning network is completely managed by the Baremetal IPI solution. `Unmanaged`- when the provsioning network is present and used but the user is responsible for managing DHCP. Virtual media provisioning is recommended but PXE is still available if required. `Disabled`- when the provisioning network is fully disabled. User can bring up the baremetal cluster using virtual media or assisted installation. If using metal3 for power management, BMCs must be accessible from the machine networks. User should provide two IPs on the external network that would be used for provisioning services. @@ -107,7 +113,7 @@ Type:: | WatchAllNamespaces provides a way to explicitly allow use of this Provisioning configuration across all Namespaces. It is an optional configuration which defaults to false and in that state will be used to provision baremetal hosts in only the openshift-machine-api namespace. When set to true, this provisioning configuration would be used for baremetal hosts across all namespaces. |=== -..spec.preProvisioningOSDownloadURLs +=== .spec.preProvisioningOSDownloadURLs Description:: + -- @@ -141,7 +147,7 @@ Type:: | RootfsURL Image URL to be used for PXE deployments |=== -..status +=== .status Description:: + -- @@ -187,7 +193,7 @@ Type:: | version is the level this availability applies to |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -200,7 +206,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -219,26 +225,26 @@ Type:: | `lastTransitionTime` | `string` -| +| | `message` | `string` -| +| | `reason` | `string` -| +| | `status` | `string` -| +| | `type` | `string` -| +| |=== -..status.generations +=== .status.generations Description:: + -- @@ -251,7 +257,7 @@ Type:: -..status.generations[] +=== .status.generations[] Description:: + -- @@ -379,7 +385,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -436,7 +444,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#provisioninglist-metal3-io-v1alpha1[`ProvisioningList metal3.io/v1alpha1`] +| xref:../objects/index.adoc#io.metal3.v1alpha1.ProvisioningList[`ProvisioningList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -463,8 +473,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| |=== .HTTP responses @@ -472,7 +482,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 201 - Created +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 202 - Accepted +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== @@ -526,8 +542,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema +| |=== .HTTP responses @@ -535,7 +551,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -562,7 +582,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -589,8 +611,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -598,7 +620,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -625,8 +649,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| |=== .HTTP responses @@ -634,7 +658,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 201 - Created +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== @@ -682,7 +710,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -709,8 +739,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| |=== .HTTP responses @@ -718,7 +748,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -745,8 +777,8 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] -| +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| |=== .HTTP responses @@ -754,5 +786,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning metal3.io/v1alpha1`] +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 201 - Created +| xref:../provisioning_apis/provisioning-metal3-io-v1alpha1.adoc#provisioning-metal3-io-v1alpha1[`Provisioning`] schema +| 401 - Unauthorized +| Empty |=== + + diff --git a/rest_api/rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc b/rest_api/rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc index e627acd61875..31f5a4688c14 100644 --- a/rest_api/rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc +++ b/rest_api/rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterrole-rbac-authorization-k8s-io-v1"] = ClusterRole [rbac.authorization.k8s.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. | `rules` @@ -49,7 +51,7 @@ Type:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..aggregationRule +=== .aggregationRule Description:: + -- @@ -67,11 +69,11 @@ Type:: | Property | Type | Description | `clusterRoleSelectors` -| xref:../objects/index.adoc#labelselector-meta-v1[`array (LabelSelector meta/v1)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`array (LabelSelector)`] | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added |=== -..rules +=== .rules Description:: + -- @@ -84,7 +86,7 @@ Type:: -..rules[] +=== .rules[] Description:: + -- @@ -133,11 +135,15 @@ The following API endpoints are available: - `DELETE`: delete collection of ClusterRole - `GET`: list or watch objects of kind ClusterRole - `POST`: create a ClusterRole +* `/apis/rbac.authorization.k8s.io/v1/watch/clusterroles` +- `GET`: watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/clusterroles/{name}` - `DELETE`: delete a ClusterRole - `GET`: read the specified ClusterRole - `PATCH`: partially update the specified ClusterRole - `PUT`: replace the specified ClusterRole +* `/apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}` +- `GET`: watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/rbac.authorization.k8s.io/v1/clusterroles @@ -211,7 +217,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -220,7 +226,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -277,7 +285,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterrolelist-rbac-authorization-k8s-io-v1[`ClusterRoleList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.ClusterRoleList[`ClusterRoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -304,7 +314,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema | |=== @@ -313,7 +323,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 201 - Created +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 202 - Accepted +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/clusterroles + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -367,7 +448,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -376,7 +457,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -391,7 +476,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -421,7 +508,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -430,7 +517,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 201 - Created +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -457,7 +548,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema | |=== @@ -466,7 +557,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 201 - Created +| xref:../rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc#clusterrole-rbac-authorization-k8s-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ClusterRole +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc b/rest_api/rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc index a2caa80c3f2d..4567dc4a91d6 100644 --- a/rest_api/rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc +++ b/rest_api/rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterrolebinding-rbac-authorization-k8s-io-v1"] = ClusterRoleBinding [rbac.authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. | `roleRef` @@ -51,7 +53,7 @@ Required:: | Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. |=== -..roleRef +=== .roleRef Description:: + -- @@ -85,7 +87,7 @@ Required:: | Name is the name of resource being referenced |=== -..subjects +=== .subjects Description:: + -- @@ -98,7 +100,7 @@ Type:: -..subjects[] +=== .subjects[] Description:: + -- @@ -144,11 +146,15 @@ The following API endpoints are available: - `DELETE`: delete collection of ClusterRoleBinding - `GET`: list or watch objects of kind ClusterRoleBinding - `POST`: create a ClusterRoleBinding +* `/apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings` +- `GET`: watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}` - `DELETE`: delete a ClusterRoleBinding - `GET`: read the specified ClusterRoleBinding - `PATCH`: partially update the specified ClusterRoleBinding - `PUT`: replace the specified ClusterRoleBinding +* `/apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}` +- `GET`: watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/rbac.authorization.k8s.io/v1/clusterrolebindings @@ -222,7 +228,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -231,7 +237,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -288,7 +296,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterrolebindinglist-rbac-authorization-k8s-io-v1[`ClusterRoleBindingList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.ClusterRoleBindingList[`ClusterRoleBindingList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -315,7 +325,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema | |=== @@ -324,7 +334,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 202 - Accepted +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -378,7 +459,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -387,7 +468,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -402,7 +487,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -432,7 +519,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -441,7 +528,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -468,7 +559,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema | |=== @@ -477,7 +568,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc#clusterrolebinding-rbac-authorization-k8s-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ClusterRoleBinding +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/rbac_apis/rbac-apis-index.adoc b/rest_api/rbac_apis/rbac-apis-index.adoc index 1c6a35d7617a..e44370e9d415 100644 --- a/rest_api/rbac_apis/rbac-apis-index.adoc +++ b/rest_api/rbac_apis/rbac-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="rbac-apis"] = RBAC APIs ifdef::product-title[] diff --git a/rest_api/rbac_apis/role-rbac-authorization-k8s-io-v1.adoc b/rest_api/rbac_apis/role-rbac-authorization-k8s-io-v1.adoc index 21824976b5ca..dd2db4b6667c 100644 --- a/rest_api/rbac_apis/role-rbac-authorization-k8s-io-v1.adoc +++ b/rest_api/rbac_apis/role-rbac-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="role-rbac-authorization-k8s-io-v1"] = Role [rbac.authorization.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. | `rules` @@ -45,7 +47,7 @@ Type:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..rules +=== .rules Description:: + -- @@ -58,7 +60,7 @@ Type:: -..rules[] +=== .rules[] Description:: + -- @@ -105,15 +107,21 @@ The following API endpoints are available: * `/apis/rbac.authorization.k8s.io/v1/roles` - `GET`: list or watch objects of kind Role +* `/apis/rbac.authorization.k8s.io/v1/watch/roles` +- `GET`: watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles` - `DELETE`: delete collection of Role - `GET`: list or watch objects of kind Role - `POST`: create a Role +* `/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles` +- `GET`: watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}` - `DELETE`: delete a Role - `GET`: read the specified Role - `PATCH`: partially update the specified Role - `PUT`: replace the specified Role +* `/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}` +- `GET`: watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/rbac.authorization.k8s.io/v1/roles @@ -175,7 +183,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolelist-rbac-authorization-k8s-io-v1[`RoleList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.RoleList[`RoleList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/roles + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -258,7 +333,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -267,7 +342,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -324,7 +401,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolelist-rbac-authorization-k8s-io-v1[`RoleList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.RoleList[`RoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -351,7 +430,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema | |=== @@ -360,7 +439,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 201 - Created +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 202 - Accepted +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -417,7 +575,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -426,7 +584,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -441,7 +603,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -471,7 +635,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -480,7 +644,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 201 - Created +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -507,7 +675,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema | |=== @@ -516,7 +684,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 201 - Created +| xref:../rbac_apis/role-rbac-authorization-k8s-io-v1.adoc#role-rbac-authorization-k8s-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Role +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc b/rest_api/rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc index 0aa507a307aa..82460cafba2d 100644 --- a/rest_api/rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc +++ b/rest_api/rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="rolebinding-rbac-authorization-k8s-io-v1"] = RoleBinding [rbac.authorization.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. | `roleRef` @@ -51,7 +53,7 @@ Required:: | Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. |=== -..roleRef +=== .roleRef Description:: + -- @@ -85,7 +87,7 @@ Required:: | Name is the name of resource being referenced |=== -..subjects +=== .subjects Description:: + -- @@ -98,7 +100,7 @@ Type:: -..subjects[] +=== .subjects[] Description:: + -- @@ -142,15 +144,21 @@ The following API endpoints are available: * `/apis/rbac.authorization.k8s.io/v1/rolebindings` - `GET`: list or watch objects of kind RoleBinding +* `/apis/rbac.authorization.k8s.io/v1/watch/rolebindings` +- `GET`: watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings` - `DELETE`: delete collection of RoleBinding - `GET`: list or watch objects of kind RoleBinding - `POST`: create a RoleBinding +* `/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings` +- `GET`: watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}` - `DELETE`: delete a RoleBinding - `GET`: read the specified RoleBinding - `PATCH`: partially update the specified RoleBinding - `PUT`: replace the specified RoleBinding +* `/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}` +- `GET`: watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/rbac.authorization.k8s.io/v1/rolebindings @@ -212,7 +220,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindinglist-rbac-authorization-k8s-io-v1[`RoleBindingList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.RoleBindingList[`RoleBindingList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/rolebindings + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -295,7 +370,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -304,7 +379,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -361,7 +438,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindinglist-rbac-authorization-k8s-io-v1[`RoleBindingList rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.RoleBindingList[`RoleBindingList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -388,7 +467,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema | |=== @@ -397,7 +476,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 202 - Accepted +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -454,7 +612,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -463,7 +621,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -478,7 +640,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -508,7 +672,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -517,7 +681,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -544,7 +712,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema | |=== @@ -553,7 +721,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding rbac.authorization.k8s.io/v1`] +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 201 - Created +| xref:../rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc#rolebinding-rbac-authorization-k8s-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the RoleBinding +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/role_apis/clusterrole-authorization-openshift-io-v1.adoc b/rest_api/role_apis/clusterrole-authorization-openshift-io-v1.adoc index 5523ea3abe08..fbf8b32085fa 100644 --- a/rest_api/role_apis/clusterrole-authorization-openshift-io-v1.adoc +++ b/rest_api/role_apis/clusterrole-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterrole-authorization-openshift-io-v1"] = ClusterRole [authorization.openshift.io/v1] ifdef::product-title[] @@ -27,7 +29,7 @@ Required:: | Property | Type | Description | `aggregationRule` -| xref:../objects/index.adoc#aggregationrule-rbac-authorization-k8s-io-v1[`AggregationRule rbac.authorization.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.rbac.v1.AggregationRule[`AggregationRule`] | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. | `apiVersion` @@ -39,7 +41,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `rules` @@ -51,7 +53,7 @@ Required:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..rules +=== .rules Description:: + -- @@ -64,7 +66,7 @@ Type:: -..rules[] +=== .rules[] Description:: + -- @@ -89,7 +91,7 @@ Required:: | APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed | `attributeRestrictions` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error. | `nonResourceURLs` @@ -190,7 +192,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterrolelist-authorization-openshift-io-v1[`ClusterRoleList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.ClusterRoleList[`ClusterRoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -217,7 +221,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema | |=== @@ -226,7 +230,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 201 - Created +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 202 - Accepted +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== @@ -280,7 +290,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -289,7 +299,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -304,7 +318,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -334,7 +350,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -343,7 +359,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -370,7 +388,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema | |=== @@ -379,7 +397,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole authorization.openshift.io/v1`] +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 201 - Created +| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc b/rest_api/role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc index ed06fbdcce68..1e780eacd9bb 100644 --- a/rest_api/role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc +++ b/rest_api/role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterrolebinding-authorization-openshift-io-v1"] = ClusterRoleBinding [authorization.openshift.io/v1] ifdef::product-title[] @@ -40,15 +42,15 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `roleRef` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | RoleRef can only reference the current namespace and the global namespace. If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role. | `subjects` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`array (ObjectReference_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`array (ObjectReference_v2)`] | Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames. | `userNames` @@ -137,7 +139,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterrolebindinglist-authorization-openshift-io-v1[`ClusterRoleBindingList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.ClusterRoleBindingList[`ClusterRoleBindingList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -164,7 +168,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema | |=== @@ -173,7 +177,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 201 - Created +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 202 - Accepted +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== @@ -227,7 +237,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -236,7 +246,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -251,7 +265,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -281,7 +297,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -290,7 +306,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -317,7 +335,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema | |=== @@ -326,7 +344,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 201 - Created +| xref:../role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc#clusterrolebinding-authorization-openshift-io-v1[`ClusterRoleBinding`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/role_apis/role-apis-index.adoc b/rest_api/role_apis/role-apis-index.adoc index 33f071ea76a8..2acdb1ddcf70 100644 --- a/rest_api/role_apis/role-apis-index.adoc +++ b/rest_api/role_apis/role-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="role-apis"] = Role APIs ifdef::product-title[] diff --git a/rest_api/role_apis/role-authorization-openshift-io-v1.adoc b/rest_api/role_apis/role-authorization-openshift-io-v1.adoc index 4f7bef5e3985..c59588a7adc5 100644 --- a/rest_api/role_apis/role-authorization-openshift-io-v1.adoc +++ b/rest_api/role_apis/role-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="role-authorization-openshift-io-v1"] = Role [authorization.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `rules` @@ -47,7 +49,7 @@ Required:: | PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. |=== -..rules +=== .rules Description:: + -- @@ -60,7 +62,7 @@ Type:: -..rules[] +=== .rules[] Description:: + -- @@ -85,7 +87,7 @@ Required:: | APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed | `attributeRestrictions` -| xref:../objects/index.adoc#rawextension-pkg-none[`RawExtension pkg/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`RawExtension`] | AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error. | `nonResourceURLs` @@ -181,7 +183,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolelist-authorization-openshift-io-v1[`RoleList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.RoleList[`RoleList`] schema +| 401 - Unauthorized +| Empty |=== @@ -259,7 +263,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolelist-authorization-openshift-io-v1[`RoleList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.RoleList[`RoleList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -286,7 +292,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema | |=== @@ -295,7 +301,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 201 - Created +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 202 - Accepted +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== @@ -352,7 +364,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -361,7 +373,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -376,7 +392,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -406,7 +424,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -415,7 +433,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -442,7 +462,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema | |=== @@ -451,7 +471,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role authorization.openshift.io/v1`] +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 201 - Created +| xref:../role_apis/role-authorization-openshift-io-v1.adoc#role-authorization-openshift-io-v1[`Role`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/role_apis/rolebinding-authorization-openshift-io-v1.adoc b/rest_api/role_apis/rolebinding-authorization-openshift-io-v1.adoc index 42ddef7f4ba5..863edea1ce9c 100644 --- a/rest_api/role_apis/rolebinding-authorization-openshift-io-v1.adoc +++ b/rest_api/role_apis/rolebinding-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="rolebinding-authorization-openshift-io-v1"] = RoleBinding [authorization.openshift.io/v1] ifdef::product-title[] @@ -40,15 +42,15 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `roleRef` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | RoleRef can only reference the current namespace and the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role. | `subjects` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`array (ObjectReference_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`array (ObjectReference_v2)`] | Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames. | `userNames` @@ -132,7 +134,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindinglist-authorization-openshift-io-v1[`RoleBindingList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.RoleBindingList[`RoleBindingList`] schema +| 401 - Unauthorized +| Empty |=== @@ -210,7 +214,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindinglist-authorization-openshift-io-v1[`RoleBindingList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.authorization.v1.RoleBindingList[`RoleBindingList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -237,7 +243,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema | |=== @@ -246,7 +252,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 201 - Created +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 202 - Accepted +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== @@ -303,7 +315,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -312,7 +324,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -327,7 +343,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -357,7 +375,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -366,7 +384,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -393,7 +413,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema | |=== @@ -402,7 +422,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding authorization.openshift.io/v1`] +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 201 - Created +| xref:../role_apis/rolebinding-authorization-openshift-io-v1.adoc#rolebinding-authorization-openshift-io-v1[`RoleBinding`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc b/rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc index 58f444cef795..49ba05452fe0 100644 --- a/rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc +++ b/rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="rolebindingrestriction-authorization-openshift-io-v1"] = RoleBindingRestriction [authorization.openshift.io/v1] ifdef::product-title[] @@ -34,7 +36,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -42,7 +44,7 @@ Type:: | Spec defines the matcher. |=== -..spec +=== .spec Description:: + -- @@ -149,7 +151,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindingrestrictionlist-authorization-openshift-io-v1[`RoleBindingRestrictionList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.authorization.v1.RoleBindingRestrictionList[`RoleBindingRestrictionList`] schema +| 401 - Unauthorized +| Empty |=== @@ -227,7 +231,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -284,7 +290,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rolebindingrestrictionlist-authorization-openshift-io-v1[`RoleBindingRestrictionList authorization.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.authorization.v1.RoleBindingRestrictionList[`RoleBindingRestrictionList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -311,7 +319,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema | |=== @@ -320,7 +328,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 201 - Created +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 202 - Accepted +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 401 - Unauthorized +| Empty |=== @@ -377,7 +391,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -386,7 +400,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -413,7 +431,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -440,7 +460,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -449,7 +469,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -476,7 +498,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema | |=== @@ -485,7 +507,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction authorization.openshift.io/v1`] +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 201 - Created +| xref:../role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc#rolebindingrestriction-authorization-openshift-io-v1[`RoleBindingRestriction`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc b/rest_api/schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc index d523a4eb895f..e9d7348e932a 100644 --- a/rest_api/schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc +++ b/rest_api/schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="appliedclusterresourcequota-quota-openshift-io-v1"] = AppliedClusterResourceQuota [quota.openshift.io/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -48,7 +50,7 @@ Required:: | ClusterResourceQuotaStatus defines the actual enforced quota and its current usage |=== -..spec +=== .spec Description:: + -- @@ -69,7 +71,7 @@ Required:: | Property | Type | Description | `quota` -| xref:../objects/index.adoc#resourcequotaspec-core-v1[`ResourceQuotaSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceQuotaSpec[`ResourceQuotaSpec`] | Quota defines the desired quota | `selector` @@ -77,7 +79,7 @@ Required:: | ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions. |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -99,11 +101,11 @@ Type:: | AnnotationSelector is used to select projects by annotation. | `labels` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | LabelSelector is used to select projects by label. |=== -..status +=== .status Description:: + -- @@ -131,11 +133,11 @@ Required:: | ResourceQuotaStatusByNamespace gives status for a particular project | `total` -| xref:../objects/index.adoc#resourcequotastatus-core-v1[`ResourceQuotaStatus core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceQuotaStatus[`ResourceQuotaStatus`] | Total defines the actual enforced quota and its current usage across all projects |=== -..status.namespaces +=== .status.namespaces Description:: + -- @@ -148,7 +150,7 @@ Type:: -..status.namespaces[] +=== .status.namespaces[] Description:: + -- @@ -173,7 +175,7 @@ Required:: | Namespace the project this status applies to | `status` -| xref:../objects/index.adoc#resourcequotastatus-core-v1[`ResourceQuotaStatus core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceQuotaStatus[`ResourceQuotaStatus`] | Status indicates how many resources have been consumed by this project |=== @@ -249,7 +251,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#appliedclusterresourcequotalist-quota-openshift-io-v1[`AppliedClusterResourceQuotaList quota.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.quota.v1.AppliedClusterResourceQuotaList[`AppliedClusterResourceQuotaList`] schema +| 401 - Unauthorized +| Empty |=== @@ -320,7 +324,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#appliedclusterresourcequotalist-quota-openshift-io-v1[`AppliedClusterResourceQuotaList quota.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.quota.v1.AppliedClusterResourceQuotaList[`AppliedClusterResourceQuotaList`] schema +| 401 - Unauthorized +| Empty |=== @@ -359,7 +365,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc#appliedclusterresourcequota-quota-openshift-io-v1[`AppliedClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc#appliedclusterresourcequota-quota-openshift-io-v1[`AppliedClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc b/rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc index c18effa3685a..f4913e7088be 100644 --- a/rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc +++ b/rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="clusterresourcequota-quota-openshift-io-v1"] = ClusterResourceQuota [quota.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -49,7 +51,7 @@ Required:: | Status defines the actual enforced quota and its current usage |=== -..spec +=== .spec Description:: + -- @@ -78,7 +80,7 @@ Required:: | Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource. |=== -..spec.quota +=== .spec.quota Description:: + -- @@ -108,7 +110,7 @@ Type:: | A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |=== -..spec.quota.scopeSelector +=== .spec.quota.scopeSelector Description:: + -- @@ -134,7 +136,7 @@ Type:: | A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. |=== -..spec.quota.scopeSelector.matchExpressions +=== .spec.quota.scopeSelector.matchExpressions Description:: + -- @@ -147,7 +149,7 @@ Type:: -..spec.quota.scopeSelector.matchExpressions[] +=== .spec.quota.scopeSelector.matchExpressions[] Description:: + -- @@ -180,7 +182,7 @@ Required:: | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |=== -..spec.selector +=== .spec.selector Description:: + -- @@ -206,7 +208,7 @@ Type:: | LabelSelector is used to select projects by label. |=== -..status +=== .status Description:: + -- @@ -234,7 +236,7 @@ Required:: | Total defines the actual enforced quota and its current usage across all projects |=== -..status.total +=== .status.total Description:: + -- @@ -269,11 +271,15 @@ The following API endpoints are available: - `DELETE`: delete collection of ClusterResourceQuota - `GET`: list objects of kind ClusterResourceQuota - `POST`: create a ClusterResourceQuota +* `/apis/quota.openshift.io/v1/watch/clusterresourcequotas` +- `GET`: watch individual changes to a list of ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/quota.openshift.io/v1/clusterresourcequotas/{name}` - `DELETE`: delete a ClusterResourceQuota - `GET`: read the specified ClusterResourceQuota - `PATCH`: partially update the specified ClusterResourceQuota - `PUT`: replace the specified ClusterResourceQuota +* `/apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name}` +- `GET`: watch changes to an object of kind ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/quota.openshift.io/v1/clusterresourcequotas/{name}/status` - `GET`: read status of the specified ClusterResourceQuota - `PATCH`: partially update status of the specified ClusterResourceQuota @@ -346,7 +352,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -403,7 +411,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#clusterresourcequotalist-quota-openshift-io-v1[`ClusterResourceQuotaList quota.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.quota.v1.ClusterResourceQuotaList[`ClusterResourceQuotaList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -430,7 +440,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema | |=== @@ -439,7 +449,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/quota.openshift.io/v1/watch/clusterresourcequotas + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -493,7 +574,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -502,7 +583,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -529,7 +614,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -556,7 +643,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -565,7 +652,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -592,7 +681,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema | |=== @@ -601,7 +690,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/quota.openshift.io/v1/watch/clusterresourcequotas/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ClusterResourceQuota +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ClusterResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -649,7 +815,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -676,7 +844,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -685,7 +853,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -712,7 +882,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema | |=== @@ -721,7 +891,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota quota.openshift.io/v1`] +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc#clusterresourcequota-quota-openshift-io-v1[`ClusterResourceQuota`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc b/rest_api/schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc index 9f7d5d921b54..19041d7e305a 100644 --- a/rest_api/schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc +++ b/rest_api/schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="flowschema-flowcontrol-apiserver-k8s-io-v1beta1"] = FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | FlowSchemaStatus represents the current state of a FlowSchema. |=== -..spec +=== .spec Description:: + -- @@ -85,7 +87,7 @@ Required:: | PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. |=== -..spec.distinguisherMethod +=== .spec.distinguisherMethod Description:: + -- @@ -109,7 +111,7 @@ Required:: | `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. |=== -..spec.priorityLevelConfiguration +=== .spec.priorityLevelConfiguration Description:: + -- @@ -133,7 +135,7 @@ Required:: | `name` is the name of the priority level configuration being referenced Required. |=== -..spec.rules +=== .spec.rules Description:: + -- @@ -146,7 +148,7 @@ Type:: -..spec.rules[] +=== .spec.rules[] Description:: + -- @@ -190,7 +192,7 @@ Required:: | Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account. |=== -..spec.rules[].nonResourceRules +=== .spec.rules[].nonResourceRules Description:: + -- @@ -203,7 +205,7 @@ Type:: -..spec.rules[].nonResourceRules[] +=== .spec.rules[].nonResourceRules[] Description:: + -- @@ -238,7 +240,7 @@ Required:: | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. |=== -..spec.rules[].resourceRules +=== .spec.rules[].resourceRules Description:: + -- @@ -251,7 +253,7 @@ Type:: -..spec.rules[].resourceRules[] +=== .spec.rules[].resourceRules[] Description:: + -- @@ -293,7 +295,7 @@ Required:: | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. |=== -..spec.rules[].subjects +=== .spec.rules[].subjects Description:: + -- @@ -306,7 +308,7 @@ Type:: -..spec.rules[].subjects[] +=== .spec.rules[].subjects[] Description:: + -- @@ -342,7 +344,7 @@ Required:: | UserSubject holds detailed information for user-kind subject. |=== -..spec.rules[].subjects[].group +=== .spec.rules[].subjects[].group Description:: + -- @@ -366,7 +368,7 @@ Required:: | name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. |=== -..spec.rules[].subjects[].serviceAccount +=== .spec.rules[].subjects[].serviceAccount Description:: + -- @@ -395,7 +397,7 @@ Required:: | `namespace` is the namespace of matching ServiceAccount objects. Required. |=== -..spec.rules[].subjects[].user +=== .spec.rules[].subjects[].user Description:: + -- @@ -419,7 +421,7 @@ Required:: | `name` is the username that matches, or "*" to match all usernames. Required. |=== -..status +=== .status Description:: + -- @@ -445,7 +447,7 @@ Type:: | FlowSchemaCondition describes conditions for a FlowSchema. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -458,7 +460,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -476,7 +478,7 @@ Type:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | `lastTransitionTime` is the last time the condition transitioned from one status to another. | `message` @@ -505,11 +507,15 @@ The following API endpoints are available: - `DELETE`: delete collection of FlowSchema - `GET`: list or watch objects of kind FlowSchema - `POST`: create a FlowSchema +* `/apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas` +- `GET`: watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}` - `DELETE`: delete a FlowSchema - `GET`: read the specified FlowSchema - `PATCH`: partially update the specified FlowSchema - `PUT`: replace the specified FlowSchema +* `/apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name}` +- `GET`: watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status` - `GET`: read status of the specified FlowSchema - `PATCH`: partially update status of the specified FlowSchema @@ -587,7 +593,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -596,7 +602,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -653,7 +661,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#flowschemalist-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchemaList flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../objects/index.adoc#io.k8s.api.flowcontrol.v1beta1.FlowSchemaList[`FlowSchemaList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -680,7 +690,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema | |=== @@ -689,7 +699,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -743,7 +824,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -752,7 +833,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -767,7 +852,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -797,7 +884,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -806,7 +893,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -833,7 +924,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema | |=== @@ -842,7 +933,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the FlowSchema +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -878,7 +1046,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -908,7 +1078,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -917,7 +1087,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -944,7 +1118,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema | |=== @@ -953,7 +1127,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc#flowschema-flowcontrol-apiserver-k8s-io-v1beta1[`FlowSchema`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/limitrange-v1.adoc b/rest_api/schedule_and_quota_apis/limitrange-v1.adoc new file mode 100644 index 000000000000..7e0bed82f102 --- /dev/null +++ b/rest_api/schedule_and_quota_apis/limitrange-v1.adoc @@ -0,0 +1,798 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="limitrange-v1"] += LimitRange [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +LimitRange sets resource usage limits for each kind of resource in a Namespace. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| LimitRangeSpec defines a min/max usage limit for resources that match on kind. + +|=== +=== .spec +Description:: ++ +-- +LimitRangeSpec defines a min/max usage limit for resources that match on kind. +-- + +Type:: + `object` + +Required:: + - `limits` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| `array` +| Limits is the list of LimitRangeItem objects that are enforced. + +| `limits[]` +| `object` +| LimitRangeItem defines a min/max usage limit for any resource that matches on kind. + +|=== +=== .spec.limits +Description:: ++ +-- +Limits is the list of LimitRangeItem objects that are enforced. +-- + +Type:: + `array` + + + + +=== .spec.limits[] +Description:: ++ +-- +LimitRangeItem defines a min/max usage limit for any resource that matches on kind. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `default` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Default resource requirement limit value by resource name if resource limit is omitted. + +| `defaultRequest` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. + +| `max` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Max usage constraints on this kind by resource name. + +| `maxLimitRequestRatio` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. + +| `min` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Min usage constraints on this kind by resource name. + +| `type` +| `string` +| Type of resource that this limit applies to. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/limitranges` +- `GET`: list or watch objects of kind LimitRange +* `/api/v1/watch/limitranges` +- `GET`: watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/limitranges` +- `DELETE`: delete collection of LimitRange +- `GET`: list or watch objects of kind LimitRange +- `POST`: create a LimitRange +* `/api/v1/watch/namespaces/{namespace}/limitranges` +- `GET`: watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/limitranges/{name}` +- `DELETE`: delete a LimitRange +- `GET`: read the specified LimitRange +- `PATCH`: partially update the specified LimitRange +- `PUT`: replace the specified LimitRange +* `/api/v1/watch/namespaces/{namespace}/limitranges/{name}` +- `GET`: watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/limitranges + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind LimitRange + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.LimitRangeList[`LimitRangeList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/limitranges + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/limitranges + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.LimitRangeList[`LimitRangeList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/limitranges + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/limitranges/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the LimitRange +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified LimitRange + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified LimitRange + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/limitrange-v1.adoc#limitrange-v1[`LimitRange`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/limitranges/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the LimitRange +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc b/rest_api/schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc index eb5032d35976..b49e04191d50 100644 --- a/rest_api/schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc +++ b/rest_api/schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="priorityclass-scheduling-k8s-io-v1"] = PriorityClass [scheduling.k8s.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `preemptionPolicy` @@ -64,11 +66,15 @@ The following API endpoints are available: - `DELETE`: delete collection of PriorityClass - `GET`: list or watch objects of kind PriorityClass - `POST`: create a PriorityClass +* `/apis/scheduling.k8s.io/v1/watch/priorityclasses` +- `GET`: watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/scheduling.k8s.io/v1/priorityclasses/{name}` - `DELETE`: delete a PriorityClass - `GET`: read the specified PriorityClass - `PATCH`: partially update the specified PriorityClass - `PUT`: replace the specified PriorityClass +* `/apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}` +- `GET`: watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/scheduling.k8s.io/v1/priorityclasses @@ -142,7 +148,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -151,7 +157,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -208,7 +216,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#priorityclasslist-scheduling-k8s-io-v1[`PriorityClassList scheduling.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.scheduling.v1.PriorityClassList[`PriorityClassList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -235,7 +245,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema | |=== @@ -244,7 +254,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/scheduling.k8s.io/v1/watch/priorityclasses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -298,7 +379,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -307,7 +388,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -322,7 +407,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -352,7 +439,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -361,7 +448,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -388,7 +479,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema | |=== @@ -397,7 +488,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass scheduling.k8s.io/v1`] +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc#priorityclass-scheduling-k8s-io-v1[`PriorityClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PriorityClass +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc b/rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc index 0a11b9b19f0a..46046841ee15 100644 --- a/rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc +++ b/rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1"] = PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | PriorityLevelConfigurationStatus represents the current state of a "request-priority". |=== -..spec +=== .spec Description:: + -- @@ -75,7 +77,7 @@ Required:: | `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. |=== -..spec.limited +=== .spec.limited Description:: + -- @@ -107,7 +109,7 @@ bigger numbers of ACS mean more reserved concurrent requests (at the expense of | LimitResponse defines how to handle requests that can not be executed right now. |=== -..spec.limited.limitResponse +=== .spec.limited.limitResponse Description:: + -- @@ -135,7 +137,7 @@ Required:: | `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. |=== -..spec.limited.limitResponse.queuing +=== .spec.limited.limitResponse.queuing Description:: + -- @@ -165,7 +167,7 @@ Type:: | `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. |=== -..status +=== .status Description:: + -- @@ -191,7 +193,7 @@ Type:: | PriorityLevelConfigurationCondition defines the condition of priority level. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -204,7 +206,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -222,7 +224,7 @@ Type:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | `lastTransitionTime` is the last time the condition transitioned from one status to another. | `message` @@ -251,11 +253,15 @@ The following API endpoints are available: - `DELETE`: delete collection of PriorityLevelConfiguration - `GET`: list or watch objects of kind PriorityLevelConfiguration - `POST`: create a PriorityLevelConfiguration +* `/apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations` +- `GET`: watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}` - `DELETE`: delete a PriorityLevelConfiguration - `GET`: read the specified PriorityLevelConfiguration - `PATCH`: partially update the specified PriorityLevelConfiguration - `PUT`: replace the specified PriorityLevelConfiguration +* `/apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations/{name}` +- `GET`: watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status` - `GET`: read status of the specified PriorityLevelConfiguration - `PATCH`: partially update status of the specified PriorityLevelConfiguration @@ -333,7 +339,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -342,7 +348,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -399,7 +407,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#prioritylevelconfigurationlist-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfigurationList flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../objects/index.adoc#io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList[`PriorityLevelConfigurationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -426,7 +436,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema | |=== @@ -435,7 +445,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -489,7 +570,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -498,7 +579,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -513,7 +598,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -543,7 +630,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -552,7 +639,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -579,7 +670,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema | |=== @@ -588,7 +679,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PriorityLevelConfiguration +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -624,7 +792,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -654,7 +824,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -663,7 +833,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -690,7 +864,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema | |=== @@ -699,7 +873,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration flowcontrol.apiserver.k8s.io/v1beta1`] +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc#prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1[`PriorityLevelConfiguration`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/schedule_and_quota_apis/resourcequota-v1.adoc b/rest_api/schedule_and_quota_apis/resourcequota-v1.adoc new file mode 100644 index 000000000000..ba806d3f09b6 --- /dev/null +++ b/rest_api/schedule_and_quota_apis/resourcequota-v1.adoc @@ -0,0 +1,973 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="resourcequota-v1"] += ResourceQuota [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ResourceQuota sets aggregate quota restrictions enforced per namespace +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| ResourceQuotaSpec defines the desired hard limits to enforce for Quota. + +| `status` +| `object` +| ResourceQuotaStatus defines the enforced hard limits and observed use. + +|=== +=== .spec +Description:: ++ +-- +ResourceQuotaSpec defines the desired hard limits to enforce for Quota. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hard` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +| `scopeSelector` +| `object` +| A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. + +| `scopes` +| `array (string)` +| A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. + +|=== +=== .spec.scopeSelector +Description:: ++ +-- +A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of scope selector requirements by scope of the resources. + +| `matchExpressions[]` +| `object` +| A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. + +|=== +=== .spec.scopeSelector.matchExpressions +Description:: ++ +-- +A list of scope selector requirements by scope of the resources. +-- + +Type:: + `array` + + + + +=== .spec.scopeSelector.matchExpressions[] +Description:: ++ +-- +A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. +-- + +Type:: + `object` + +Required:: + - `scopeName` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `operator` +| `string` +| Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. + +| `scopeName` +| `string` +| The name of the scope that the selector applies to. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + +|=== +=== .status +Description:: ++ +-- +ResourceQuotaStatus defines the enforced hard limits and observed use. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hard` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +| `used` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Used is the current observed total usage of the resource in the namespace. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/resourcequotas` +- `GET`: list or watch objects of kind ResourceQuota +* `/api/v1/watch/resourcequotas` +- `GET`: watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/resourcequotas` +- `DELETE`: delete collection of ResourceQuota +- `GET`: list or watch objects of kind ResourceQuota +- `POST`: create a ResourceQuota +* `/api/v1/watch/namespaces/{namespace}/resourcequotas` +- `GET`: watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/resourcequotas/{name}` +- `DELETE`: delete a ResourceQuota +- `GET`: read the specified ResourceQuota +- `PATCH`: partially update the specified ResourceQuota +- `PUT`: replace the specified ResourceQuota +* `/api/v1/watch/namespaces/{namespace}/resourcequotas/{name}` +- `GET`: watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{namespace}/resourcequotas/{name}/status` +- `GET`: read status of the specified ResourceQuota +- `PATCH`: partially update status of the specified ResourceQuota +- `PUT`: replace status of the specified ResourceQuota + + +=== /api/v1/resourcequotas + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ResourceQuota + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceQuotaList[`ResourceQuotaList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/resourcequotas + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/resourcequotas + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceQuotaList[`ResourceQuotaList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/resourcequotas + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/resourcequotas/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ResourceQuota +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 202 - Accepted +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ResourceQuota + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/resourcequotas/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ResourceQuota +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/resourcequotas/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ResourceQuota +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified ResourceQuota + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified ResourceQuota + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 201 - Created +| xref:../schedule_and_quota_apis/resourcequota-v1.adoc#resourcequota-v1[`ResourceQuota`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/schedule_and_quota_apis/schedule-and-quota-apis-index.adoc b/rest_api/schedule_and_quota_apis/schedule-and-quota-apis-index.adoc index 806055bf0257..59e9caa836ba 100644 --- a/rest_api/schedule_and_quota_apis/schedule-and-quota-apis-index.adoc +++ b/rest_api/schedule_and_quota_apis/schedule-and-quota-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="schedule-and-quota-apis"] = Schedule and quota APIs ifdef::product-title[] @@ -40,7 +42,7 @@ FlowSchema defines the schema of a group of flows. Note that a flow is made up o Type:: `object` -== LimitRange [core/v1] +== LimitRange [v1] Description:: + @@ -73,7 +75,7 @@ PriorityLevelConfiguration represents the configuration of a priority level. Type:: `object` -== ResourceQuota [core/v1] +== ResourceQuota [v1] Description:: + diff --git a/rest_api/security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc b/rest_api/security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc index 423db89e9abf..6dd2c22cf53e 100644 --- a/rest_api/security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc +++ b/rest_api/security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="certificatesigningrequest-certificates-k8s-io-v1"] = CertificateSigningRequest [certificates.k8s.io/v1] ifdef::product-title[] @@ -41,7 +43,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -53,7 +55,7 @@ Required:: | CertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate. |=== -..spec +=== .spec Description:: + -- @@ -156,7 +158,7 @@ Valid values are: | username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. |=== -..spec.extra +=== .spec.extra Description:: + -- @@ -169,7 +171,7 @@ Type:: -..status +=== .status Description:: + -- @@ -220,7 +222,7 @@ When serialized as JSON or YAML, the data is additionally base64-encoded, so it | CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -233,7 +235,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -254,11 +256,11 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time. | `lastUpdateTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | lastUpdateTime is the time of the last update to this condition | `message` @@ -297,11 +299,15 @@ The following API endpoints are available: - `DELETE`: delete collection of CertificateSigningRequest - `GET`: list or watch objects of kind CertificateSigningRequest - `POST`: create a CertificateSigningRequest +* `/apis/certificates.k8s.io/v1/watch/certificatesigningrequests` +- `GET`: watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}` - `DELETE`: delete a CertificateSigningRequest - `GET`: read the specified CertificateSigningRequest - `PATCH`: partially update the specified CertificateSigningRequest - `PUT`: replace the specified CertificateSigningRequest +* `/apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}` +- `GET`: watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status` - `GET`: read status of the specified CertificateSigningRequest - `PATCH`: partially update status of the specified CertificateSigningRequest @@ -383,7 +389,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -392,7 +398,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -449,7 +457,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#certificatesigningrequestlist-certificates-k8s-io-v1[`CertificateSigningRequestList certificates.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.certificates.v1.CertificateSigningRequestList[`CertificateSigningRequestList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -476,7 +486,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema | |=== @@ -485,7 +495,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 202 - Accepted +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/certificates.k8s.io/v1/watch/certificatesigningrequests + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -539,7 +620,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -548,7 +629,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -563,7 +648,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -593,7 +680,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -602,7 +689,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -629,7 +720,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema | |=== @@ -638,7 +729,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CertificateSigningRequest +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -674,7 +842,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -704,7 +874,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -713,7 +883,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -740,7 +914,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema | |=== @@ -749,7 +923,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== @@ -785,7 +963,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -815,7 +995,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -824,7 +1004,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -851,7 +1035,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema | |=== @@ -860,7 +1044,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest certificates.k8s.io/v1`] +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 201 - Created +| xref:../security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc#certificatesigningrequest-certificates-k8s-io-v1[`CertificateSigningRequest`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc b/rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc index d39f9be413a1..13c4904d1340 100644 --- a/rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc +++ b/rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="credentialsrequest-cloudcredential-openshift-io-v1"] = CredentialsRequest [cloudcredential.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | CredentialsRequestStatus defines the observed state of CredentialsRequest |=== -..spec +=== .spec Description:: + -- @@ -79,7 +81,7 @@ Required:: | ServiceAccountNames contains a list of ServiceAccounts that will use permissions associated with this CredentialsRequest. This is not used by CCO, but the information is needed for being able to properly set up access control in the cloud provider when the ServiceAccounts are used as part of the cloud credentials flow. |=== -..spec.secretRef +=== .spec.secretRef Description:: + -- @@ -125,7 +127,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status +=== .status Description:: + -- @@ -174,7 +176,7 @@ Required:: | Provisioned is true once the credentials have been initially provisioned. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -187,7 +189,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -313,7 +315,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#credentialsrequestlist-cloudcredential-openshift-io-v1[`CredentialsRequestList cloudcredential.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.cloudcredential.v1.CredentialsRequestList[`CredentialsRequestList`] schema +| 401 - Unauthorized +| Empty |=== @@ -391,7 +395,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -448,7 +454,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#credentialsrequestlist-cloudcredential-openshift-io-v1[`CredentialsRequestList cloudcredential.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.cloudcredential.v1.CredentialsRequestList[`CredentialsRequestList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -475,7 +483,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema | |=== @@ -484,7 +492,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 201 - Created +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 202 - Accepted +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== @@ -541,7 +555,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -550,7 +564,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -577,7 +595,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -604,7 +624,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -613,7 +633,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -640,7 +662,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema | |=== @@ -649,7 +671,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 201 - Created +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== @@ -700,7 +726,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -727,7 +755,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -736,7 +764,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -763,7 +793,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema | |=== @@ -772,7 +802,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest cloudcredential.openshift.io/v1`] +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 201 - Created +| xref:../security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc b/rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc index 141bd0fb43e7..bfd8d5c291a9 100644 --- a/rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="podsecuritypolicyreview-security-openshift-io-v1"] = PodSecurityPolicyReview [security.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview. |=== -..spec +=== .spec Description:: + -- @@ -67,11 +69,11 @@ Required:: | serviceAccountNames is an optional set of ServiceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it's empty, in which case "default" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case "default" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored. |=== -..status +=== .status Description:: + -- @@ -99,7 +101,7 @@ Required:: | ServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status |=== -..status.allowedServiceAccounts +=== .status.allowedServiceAccounts Description:: + -- @@ -112,7 +114,7 @@ Type:: -..status.allowedServiceAccounts[] +=== .status.allowedServiceAccounts[] Description:: + -- @@ -132,7 +134,7 @@ Required:: | Property | Type | Description | `allowedBy` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied. | `name` @@ -144,7 +146,7 @@ Required:: | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec after the defaulting is applied. |=== @@ -196,7 +198,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview`] schema | |=== @@ -205,7 +207,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview`] schema +| 201 - Created +| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview`] schema +| 202 - Accepted +| xref:../security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc#podsecuritypolicyreview-security-openshift-io-v1[`PodSecurityPolicyReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc b/rest_api/security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc index 5ed9310a3ce0..5b8120099f03 100644 --- a/rest_api/security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="podsecuritypolicyselfsubjectreview-security-openshift-io-v1"] = PodSecurityPolicySelfSubjectReview [security.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview. |=== -..spec +=== .spec Description:: + -- @@ -63,11 +65,11 @@ Required:: | Property | Type | Description | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec to check. |=== -..status +=== .status Description:: + -- @@ -85,7 +87,7 @@ Type:: | Property | Type | Description | `allowedBy` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied. | `reason` @@ -93,7 +95,7 @@ Type:: | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec after the defaulting is applied. |=== @@ -145,7 +147,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview`] schema | |=== @@ -154,7 +156,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview`] schema +| 201 - Created +| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview`] schema +| 202 - Accepted +| xref:../security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc#podsecuritypolicyselfsubjectreview-security-openshift-io-v1[`PodSecurityPolicySelfSubjectReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc b/rest_api/security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc index f5b302a74439..161ee97abfd5 100644 --- a/rest_api/security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="podsecuritypolicysubjectreview-security-openshift-io-v1"] = PodSecurityPolicySubjectReview [security.openshift.io/v1] ifdef::product-title[] @@ -43,7 +45,7 @@ Required:: | PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview. |=== -..spec +=== .spec Description:: + -- @@ -67,7 +69,7 @@ Required:: | groups is the groups you're testing for. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked. | `user` @@ -75,7 +77,7 @@ Required:: | user is the user you're testing for. If you specify "user" but not "group", then is it interpreted as "What if user were not a member of any groups. If user and groups are empty, then the check is performed using *only* the serviceAccountName in the template. |=== -..status +=== .status Description:: + -- @@ -93,7 +95,7 @@ Type:: | Property | Type | Description | `allowedBy` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied. | `reason` @@ -101,7 +103,7 @@ Type:: | A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the PodTemplateSpec after the defaulting is applied. |=== @@ -153,7 +155,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview`] schema | |=== @@ -162,7 +164,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview security.openshift.io/v1`] +| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview`] schema +| 201 - Created +| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview`] schema +| 202 - Accepted +| xref:../security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc#podsecuritypolicysubjectreview-security-openshift-io-v1[`PodSecurityPolicySubjectReview`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/rangeallocation-security-openshift-io-v1.adoc b/rest_api/security_apis/rangeallocation-security-openshift-io-v1.adoc index 01e441d61add..65a969b8b200 100644 --- a/rest_api/security_apis/rangeallocation-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/rangeallocation-security-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="rangeallocation-security-openshift-io-v1"] = RangeAllocation [security.openshift.io/v1] ifdef::product-title[] @@ -40,7 +42,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `range` @@ -57,11 +59,15 @@ The following API endpoints are available: - `DELETE`: delete collection of RangeAllocation - `GET`: list or watch objects of kind RangeAllocation - `POST`: create a RangeAllocation +* `/apis/security.openshift.io/v1/watch/rangeallocations` +- `GET`: watch individual changes to a list of RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/security.openshift.io/v1/rangeallocations/{name}` - `DELETE`: delete a RangeAllocation - `GET`: read the specified RangeAllocation - `PATCH`: partially update the specified RangeAllocation - `PUT`: replace the specified RangeAllocation +* `/apis/security.openshift.io/v1/watch/rangeallocations/{name}` +- `GET`: watch changes to an object of kind RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/security.openshift.io/v1/rangeallocations @@ -135,7 +141,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -144,7 +150,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -201,7 +209,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#rangeallocationlist-security-openshift-io-v1[`RangeAllocationList security.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.security.v1.RangeAllocationList[`RangeAllocationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -228,7 +238,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema | |=== @@ -237,7 +247,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 201 - Created +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 202 - Accepted +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/rangeallocations + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -291,7 +372,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -300,7 +381,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -315,7 +400,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -345,7 +432,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -354,7 +441,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -381,7 +470,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema | |=== @@ -390,7 +479,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation security.openshift.io/v1`] +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 201 - Created +| xref:../security_apis/rangeallocation-security-openshift-io-v1.adoc#rangeallocation-security-openshift-io-v1[`RangeAllocation`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/rangeallocations/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the RangeAllocation +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/secret-v1.adoc b/rest_api/security_apis/secret-v1.adoc new file mode 100644 index 000000000000..e42f0d00ab59 --- /dev/null +++ b/rest_api/security_apis/secret-v1.adoc @@ -0,0 +1,725 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="secret-v1"] += Secret [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `data` +| `object (string)` +| Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + +| `immutable` +| `boolean` +| Immutable, if set to true, ensures that data stored in the Secret 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. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `stringData` +| `object (string)` +| stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. + +| `type` +| `string` +| Used to facilitate programmatic handling of secret data. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/secrets` +- `GET`: list or watch objects of kind Secret +* `/api/v1/watch/secrets` +- `GET`: watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/secrets` +- `DELETE`: delete collection of Secret +- `GET`: list or watch objects of kind Secret +- `POST`: create a Secret +* `/api/v1/watch/namespaces/{namespace}/secrets` +- `GET`: watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/secrets/{name}` +- `DELETE`: delete a Secret +- `GET`: read the specified Secret +- `PATCH`: partially update the specified Secret +- `PUT`: replace the specified Secret +* `/api/v1/watch/namespaces/{namespace}/secrets/{name}` +- `GET`: watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/secrets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Secret + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretList[`SecretList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/secrets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/secrets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretList[`SecretList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 201 - Created +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 202 - Accepted +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/secrets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/secrets/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Secret +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Secret + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 201 - Created +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Secret + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 201 - Created +| xref:../security_apis/secret-v1.adoc#secret-v1[`Secret`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/secrets/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Secret +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/security_apis/security-apis-index.adoc b/rest_api/security_apis/security-apis-index.adoc index fb39c743c1ab..d0c9298c4969 100644 --- a/rest_api/security_apis/security-apis-index.adoc +++ b/rest_api/security_apis/security-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="security-apis"] = Security APIs ifdef::product-title[] @@ -78,7 +80,7 @@ RangeAllocation is used so we can easily expose a RangeAllocation typed for secu Type:: `object` -== Secret [core/v1] +== Secret [v1] Description:: + @@ -101,7 +103,7 @@ SecurityContextConstraints governs the ability to make requests that affect the Type:: `object` -== ServiceAccount [core/v1] +== ServiceAccount [v1] Description:: + diff --git a/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc b/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc index 563c65e25e8e..5feb9a6eb027 100644 --- a/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc +++ b/rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="securitycontextconstraints-security-openshift-io-v1"] = SecurityContextConstraints [security.openshift.io/v1] ifdef::product-title[] @@ -104,7 +106,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `priority` @@ -153,11 +155,15 @@ The following API endpoints are available: - `DELETE`: delete collection of SecurityContextConstraints - `GET`: list objects of kind SecurityContextConstraints - `POST`: create SecurityContextConstraints +* `/apis/security.openshift.io/v1/watch/securitycontextconstraints` +- `GET`: watch individual changes to a list of SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/security.openshift.io/v1/securitycontextconstraints/{name}` - `DELETE`: delete SecurityContextConstraints - `GET`: read the specified SecurityContextConstraints - `PATCH`: partially update the specified SecurityContextConstraints - `PUT`: replace the specified SecurityContextConstraints +* `/apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}` +- `GET`: watch changes to an object of kind SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/security.openshift.io/v1/securitycontextconstraints @@ -226,7 +232,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -283,7 +291,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#securitycontextconstraintslist-security-openshift-io-v1[`SecurityContextConstraintsList security.openshift.io/v1`] +| xref:../objects/index.adoc#io.openshift.security.v1.SecurityContextConstraintsList[`SecurityContextConstraintsList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -310,7 +320,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema | |=== @@ -319,7 +329,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 201 - Created +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 202 - Accepted +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/securitycontextconstraints + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -373,7 +454,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -382,7 +463,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -409,7 +494,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -436,7 +523,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -445,7 +532,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -472,7 +561,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema | |=== @@ -481,7 +570,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints security.openshift.io/v1`] +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 201 - Created +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the SecurityContextConstraints +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/security_apis/serviceaccount-v1.adoc b/rest_api/security_apis/serviceaccount-v1.adoc new file mode 100644 index 000000000000..d7243dbf8f91 --- /dev/null +++ b/rest_api/security_apis/serviceaccount-v1.adoc @@ -0,0 +1,823 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="serviceaccount-v1"] += ServiceAccount [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `automountServiceAccountToken` +| `boolean` +| AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. + +| `imagePullSecrets` +| `array` +| ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod + +| `imagePullSecrets[]` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `secrets` +| `array` +| Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret + +| `secrets[]` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +|=== +=== .imagePullSecrets +Description:: ++ +-- +ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod +-- + +Type:: + `array` + + + + +=== .imagePullSecrets[] +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .secrets +Description:: ++ +-- +Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret +-- + +Type:: + `array` + + + + +=== .secrets[] +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/serviceaccounts` +- `GET`: list or watch objects of kind ServiceAccount +* `/api/v1/watch/serviceaccounts` +- `GET`: watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/serviceaccounts` +- `DELETE`: delete collection of ServiceAccount +- `GET`: list or watch objects of kind ServiceAccount +- `POST`: create a ServiceAccount +* `/api/v1/watch/namespaces/{namespace}/serviceaccounts` +- `GET`: watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/serviceaccounts/{name}` +- `DELETE`: delete a ServiceAccount +- `GET`: read the specified ServiceAccount +- `PATCH`: partially update the specified ServiceAccount +- `PUT`: replace the specified ServiceAccount +* `/api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}` +- `GET`: watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/serviceaccounts + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ServiceAccount + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ServiceAccountList[`ServiceAccountList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/serviceaccounts + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/serviceaccounts + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ServiceAccountList[`ServiceAccountList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 201 - Created +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 202 - Accepted +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/serviceaccounts + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/serviceaccounts/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ServiceAccount +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 202 - Accepted +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ServiceAccount + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 201 - Created +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified ServiceAccount + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 201 - Created +| xref:../security_apis/serviceaccount-v1.adoc#serviceaccount-v1[`ServiceAccount`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ServiceAccount +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/storage_apis/csidriver-storage-k8s-io-v1.adoc b/rest_api/storage_apis/csidriver-storage-k8s-io-v1.adoc index 4d4eba827661..88ce76b67aff 100644 --- a/rest_api/storage_apis/csidriver-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/csidriver-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="csidriver-storage-k8s-io-v1"] = CSIDriver [storage.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | 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 | `spec` @@ -43,7 +45,7 @@ Required:: | CSIDriverSpec is the specification of a CSIDriver. |=== -..spec +=== .spec Description:: + -- @@ -124,7 +126,7 @@ Note: Audience in each TokenRequest should be different and at most one token is This field is immutable. |=== -..spec.tokenRequests +=== .spec.tokenRequests Description:: + -- @@ -145,7 +147,7 @@ Type:: -..spec.tokenRequests[] +=== .spec.tokenRequests[] Description:: + -- @@ -182,11 +184,15 @@ The following API endpoints are available: - `DELETE`: delete collection of CSIDriver - `GET`: list or watch objects of kind CSIDriver - `POST`: create a CSIDriver +* `/apis/storage.k8s.io/v1/watch/csidrivers` +- `GET`: watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1/csidrivers/{name}` - `DELETE`: delete a CSIDriver - `GET`: read the specified CSIDriver - `PATCH`: partially update the specified CSIDriver - `PUT`: replace the specified CSIDriver +* `/apis/storage.k8s.io/v1/watch/csidrivers/{name}` +- `GET`: watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/storage.k8s.io/v1/csidrivers @@ -260,7 +266,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -269,7 +275,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -326,7 +334,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#csidriverlist-storage-k8s-io-v1[`CSIDriverList storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1.CSIDriverList[`CSIDriverList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -353,7 +363,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema | |=== @@ -362,7 +372,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 201 - Created +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 202 - Accepted +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/csidrivers + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -416,7 +497,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -425,7 +506,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 202 - Accepted +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -440,7 +525,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -470,7 +557,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -479,7 +566,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 201 - Created +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -506,7 +597,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema | |=== @@ -515,7 +606,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver storage.k8s.io/v1`] +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 201 - Created +| xref:../storage_apis/csidriver-storage-k8s-io-v1.adoc#csidriver-storage-k8s-io-v1[`CSIDriver`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/csidrivers/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CSIDriver +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/csinode-storage-k8s-io-v1.adoc b/rest_api/storage_apis/csinode-storage-k8s-io-v1.adoc index 0ac7bae0aada..66762acf94aa 100644 --- a/rest_api/storage_apis/csinode-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/csinode-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="csinode-storage-k8s-io-v1"] = CSINode [storage.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | metadata.name must be the Kubernetes node name. | `spec` @@ -43,7 +45,7 @@ Required:: | CSINodeSpec holds information about the specification of all CSI drivers installed on a node |=== -..spec +=== .spec Description:: + -- @@ -71,7 +73,7 @@ Required:: | CSINodeDriver holds information about the specification of one CSI driver installed on a node |=== -..spec.drivers +=== .spec.drivers Description:: + -- @@ -84,7 +86,7 @@ Type:: -..spec.drivers[] +=== .spec.drivers[] Description:: + -- @@ -121,7 +123,7 @@ Required:: | topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. |=== -..spec.drivers[].allocatable +=== .spec.drivers[].allocatable Description:: + -- @@ -152,11 +154,15 @@ The following API endpoints are available: - `DELETE`: delete collection of CSINode - `GET`: list or watch objects of kind CSINode - `POST`: create a CSINode +* `/apis/storage.k8s.io/v1/watch/csinodes` +- `GET`: watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1/csinodes/{name}` - `DELETE`: delete a CSINode - `GET`: read the specified CSINode - `PATCH`: partially update the specified CSINode - `PUT`: replace the specified CSINode +* `/apis/storage.k8s.io/v1/watch/csinodes/{name}` +- `GET`: watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/storage.k8s.io/v1/csinodes @@ -230,7 +236,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -239,7 +245,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -296,7 +304,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#csinodelist-storage-k8s-io-v1[`CSINodeList storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1.CSINodeList[`CSINodeList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -323,7 +333,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema | |=== @@ -332,7 +342,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 201 - Created +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 202 - Accepted +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/csinodes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -386,7 +467,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -395,7 +476,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 202 - Accepted +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -410,7 +495,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -440,7 +527,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -449,7 +536,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 201 - Created +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -476,7 +567,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema | |=== @@ -485,7 +576,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode storage.k8s.io/v1`] +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 201 - Created +| xref:../storage_apis/csinode-storage-k8s-io-v1.adoc#csinode-storage-k8s-io-v1[`CSINode`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/csinodes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CSINode +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc b/rest_api/storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc index cd5f5dee8736..f11b0b4eab00 100644 --- a/rest_api/storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc +++ b/rest_api/storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="csistoragecapacity-storage-k8s-io-v1beta1"] = CSIStorageCapacity [storage.k8s.io/v1beta1] ifdef::product-title[] @@ -39,7 +41,7 @@ Required:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `capacity` -| xref:../objects/index.adoc#quantity-api-none[`Quantity api/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] | 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 and treated like zero capacity. @@ -49,13 +51,13 @@ The semantic is currently (CSI spec 1.2) defined as: The available capacity, in | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `maximumVolumeSize` -| xref:../objects/index.adoc#quantity-api-none[`Quantity api/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] | 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. | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. The name has no particular meaning. It must be 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-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. @@ -63,7 +65,7 @@ Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `nodeTopology` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | 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. | `storageClassName` @@ -78,15 +80,21 @@ The following API endpoints are available: * `/apis/storage.k8s.io/v1beta1/csistoragecapacities` - `GET`: list or watch objects of kind CSIStorageCapacity +* `/apis/storage.k8s.io/v1beta1/watch/csistoragecapacities` +- `GET`: watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities` - `DELETE`: delete collection of CSIStorageCapacity - `GET`: list or watch objects of kind CSIStorageCapacity - `POST`: create a CSIStorageCapacity +* `/apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities` +- `GET`: watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}` - `DELETE`: delete a CSIStorageCapacity - `GET`: read the specified CSIStorageCapacity - `PATCH`: partially update the specified CSIStorageCapacity - `PUT`: replace the specified CSIStorageCapacity +* `/apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities/{name}` +- `GET`: watch changes to an object of kind CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/storage.k8s.io/v1beta1/csistoragecapacities @@ -148,7 +156,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#csistoragecapacitylist-storage-k8s-io-v1beta1[`CSIStorageCapacityList storage.k8s.io/v1beta1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1beta1.CSIStorageCapacityList[`CSIStorageCapacityList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1beta1/watch/csistoragecapacities + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -231,7 +306,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -240,7 +315,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -297,7 +374,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#csistoragecapacitylist-storage-k8s-io-v1beta1[`CSIStorageCapacityList storage.k8s.io/v1beta1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1beta1.CSIStorageCapacityList[`CSIStorageCapacityList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -324,7 +403,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema | |=== @@ -333,7 +412,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 201 - Created +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 202 - Accepted +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -390,7 +548,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -399,7 +557,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -414,7 +576,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -444,7 +608,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -453,7 +617,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 201 - Created +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -480,7 +648,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema | |=== @@ -489,7 +657,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity storage.k8s.io/v1beta1`] +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 201 - Created +| xref:../storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc#csistoragecapacity-storage-k8s-io-v1beta1[`CSIStorageCapacity`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1beta1/watch/namespaces/{namespace}/csistoragecapacities/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CSIStorageCapacity +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/persistentvolumeclaim-v1.adoc b/rest_api/storage_apis/persistentvolumeclaim-v1.adoc new file mode 100644 index 000000000000..9f4e4e129cd8 --- /dev/null +++ b/rest_api/storage_apis/persistentvolumeclaim-v1.adoc @@ -0,0 +1,1083 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="persistentvolumeclaim-v1"] += PersistentVolumeClaim [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +PersistentVolumeClaim is a user's request for and claim to a persistent volume +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + +| `status` +| `object` +| PersistentVolumeClaimStatus is the current status of a persistent volume claim. + +|=== +=== .spec +Description:: ++ +-- +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +| `dataSource` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `dataSourceRef` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `selector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over volumes to consider for binding. + +| `storageClassName` +| `string` +| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + +| `volumeMode` +| `string` +| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + +| `volumeName` +| `string` +| VolumeName is the binding reference to the PersistentVolume backing this claim. + +|=== +=== .spec.dataSource +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.dataSourceRef +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .status +Description:: ++ +-- +PersistentVolumeClaimStatus is the current status of a persistent volume claim. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +| `capacity` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Represents the actual resources of the underlying volume. + +| `conditions` +| `array` +| Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. + +| `conditions[]` +| `object` +| PersistentVolumeClaimCondition contails details about state of pvc + +| `phase` +| `string` +| Phase represents the current phase of PersistentVolumeClaim. + +|=== +=== .status.conditions +Description:: ++ +-- +Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +PersistentVolumeClaimCondition contails details about state of pvc +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastProbeTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time we probed the condition. + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time the condition transitioned from one status to another. + +| `message` +| `string` +| Human-readable message indicating details about last transition. + +| `reason` +| `string` +| Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. + +| `status` +| `string` +| + +| `type` +| `string` +| + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/persistentvolumeclaims` +- `GET`: list or watch objects of kind PersistentVolumeClaim +* `/api/v1/watch/persistentvolumeclaims` +- `GET`: watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/persistentvolumeclaims` +- `DELETE`: delete collection of PersistentVolumeClaim +- `GET`: list or watch objects of kind PersistentVolumeClaim +- `POST`: create a PersistentVolumeClaim +* `/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims` +- `GET`: watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}` +- `DELETE`: delete a PersistentVolumeClaim +- `GET`: read the specified PersistentVolumeClaim +- `PATCH`: partially update the specified PersistentVolumeClaim +- `PUT`: replace the specified PersistentVolumeClaim +* `/api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}` +- `GET`: watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status` +- `GET`: read status of the specified PersistentVolumeClaim +- `PATCH`: partially update status of the specified PersistentVolumeClaim +- `PUT`: replace status of the specified PersistentVolumeClaim + + +=== /api/v1/persistentvolumeclaims + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind PersistentVolumeClaim + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PersistentVolumeClaimList[`PersistentVolumeClaimList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/persistentvolumeclaims + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/persistentvolumeclaims + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PersistentVolumeClaimList[`PersistentVolumeClaimList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 201 - Created +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 202 - Accepted +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolumeClaim +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 202 - Accepted +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified PersistentVolumeClaim + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 201 - Created +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 201 - Created +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolumeClaim +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolumeClaim +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified PersistentVolumeClaim + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 201 - Created +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified PersistentVolumeClaim + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 201 - Created +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`PersistentVolumeClaim`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/storage_apis/storage-apis-index.adoc b/rest_api/storage_apis/storage-apis-index.adoc index 6626f50f0c7f..d0f97c755f2f 100644 --- a/rest_api/storage_apis/storage-apis-index.adoc +++ b/rest_api/storage_apis/storage-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="storage-apis"] = Storage APIs ifdef::product-title[] @@ -47,7 +49,7 @@ They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature g Type:: `object` -== PersistentVolumeClaim [core/v1] +== PersistentVolumeClaim [v1] Description:: + diff --git a/rest_api/storage_apis/storageclass-storage-k8s-io-v1.adoc b/rest_api/storage_apis/storageclass-storage-k8s-io-v1.adoc index 9ff89fc60a11..fca2ceb2fe4c 100644 --- a/rest_api/storage_apis/storageclass-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/storageclass-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="storageclass-storage-k8s-io-v1"] = StorageClass [storage.k8s.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Required:: | AllowVolumeExpansion shows whether the storage class allow volume expand | `allowedTopologies` -| xref:../objects/index.adoc#topologyselectorterm-core-v1[`array (TopologySelectorTerm core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.TopologySelectorTerm[`array (TopologySelectorTerm)`] | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. | `apiVersion` @@ -45,7 +47,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `mountOptions` @@ -78,11 +80,15 @@ The following API endpoints are available: - `DELETE`: delete collection of StorageClass - `GET`: list or watch objects of kind StorageClass - `POST`: create a StorageClass +* `/apis/storage.k8s.io/v1/watch/storageclasses` +- `GET`: watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1/storageclasses/{name}` - `DELETE`: delete a StorageClass - `GET`: read the specified StorageClass - `PATCH`: partially update the specified StorageClass - `PUT`: replace the specified StorageClass +* `/apis/storage.k8s.io/v1/watch/storageclasses/{name}` +- `GET`: watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/storage.k8s.io/v1/storageclasses @@ -156,7 +162,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -165,7 +171,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -222,7 +230,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#storageclasslist-storage-k8s-io-v1[`StorageClassList storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1.StorageClassList[`StorageClassList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -249,7 +259,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema | |=== @@ -258,7 +268,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 201 - Created +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 202 - Accepted +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/storageclasses + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -312,7 +393,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -321,7 +402,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 202 - Accepted +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -336,7 +421,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -366,7 +453,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -375,7 +462,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 201 - Created +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -402,7 +493,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema | |=== @@ -411,7 +502,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass storage.k8s.io/v1`] +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 201 - Created +| xref:../storage_apis/storageclass-storage-k8s-io-v1.adoc#storageclass-storage-k8s-io-v1[`StorageClass`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/storageclasses/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the StorageClass +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc b/rest_api/storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc index 2aa858b74616..c439eefa2bcc 100644 --- a/rest_api/storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc +++ b/rest_api/storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="storagestate-migration-k8s-io-v1alpha1"] = StorageState [migration.k8s.io/v1alpha1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | Status of the storage state. |=== -..spec +=== .spec Description:: + -- @@ -67,7 +69,7 @@ Type:: | The resource this storageState is about. |=== -..spec.resource +=== .spec.resource Description:: + -- @@ -93,7 +95,7 @@ Type:: | The name of the resource. |=== -..status +=== .status Description:: + -- @@ -209,7 +211,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -266,7 +270,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#storagestatelist-migration-k8s-io-v1alpha1[`StorageStateList migration.k8s.io/v1alpha1`] +| xref:../objects/index.adoc#io.k8s.migration.v1alpha1.StorageStateList[`StorageStateList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -293,7 +299,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema | |=== @@ -302,7 +308,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 201 - Created +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 202 - Accepted +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== @@ -356,7 +368,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -365,7 +377,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -392,7 +408,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -419,7 +437,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -428,7 +446,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -455,7 +475,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema | |=== @@ -464,7 +484,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 201 - Created +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== @@ -512,7 +536,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -539,7 +565,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -548,7 +574,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -575,7 +603,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema | |=== @@ -584,7 +612,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 201 - Created +| xref:../storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc#storagestate-migration-k8s-io-v1alpha1[`StorageState`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc b/rest_api/storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc index b61433bc5bd3..b2d26992ae67 100644 --- a/rest_api/storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc +++ b/rest_api/storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="storageversionmigration-migration-k8s-io-v1alpha1"] = StorageVersionMigration [migration.k8s.io/v1alpha1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | Status of the migration. |=== -..spec +=== .spec Description:: + -- @@ -73,7 +75,7 @@ Required:: | The resource that is being migrated. The migrator sends requests to the endpoint serving the resource. Immutable. |=== -..spec.resource +=== .spec.resource Description:: + -- @@ -103,7 +105,7 @@ Type:: | The name of the version. |=== -..status +=== .status Description:: + -- @@ -129,7 +131,7 @@ Type:: | Describes the state of a migration at a certain point. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -142,7 +144,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -269,7 +271,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -326,7 +330,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#storageversionmigrationlist-migration-k8s-io-v1alpha1[`StorageVersionMigrationList migration.k8s.io/v1alpha1`] +| xref:../objects/index.adoc#io.k8s.migration.v1alpha1.StorageVersionMigrationList[`StorageVersionMigrationList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -353,7 +359,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema | |=== @@ -362,7 +368,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 201 - Created +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 202 - Accepted +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== @@ -416,7 +428,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -425,7 +437,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -452,7 +468,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -479,7 +497,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -488,7 +506,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -515,7 +535,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema | |=== @@ -524,7 +544,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 201 - Created +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== @@ -572,7 +596,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -599,7 +625,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -608,7 +634,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -635,7 +663,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema | |=== @@ -644,7 +672,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration migration.k8s.io/v1alpha1`] +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 201 - Created +| xref:../storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc#storageversionmigration-migration-k8s-io-v1alpha1[`StorageVersionMigration`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc b/rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc index 7ae097bd8483..2401405307e3 100644 --- a/rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="volumeattachment-storage-k8s-io-v1"] = VolumeAttachment [storage.k8s.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -49,7 +51,7 @@ Required:: | VolumeAttachmentStatus is the status of a VolumeAttachment request. |=== -..spec +=== .spec Description:: + -- @@ -83,7 +85,7 @@ Required:: | VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. |=== -..spec.source +=== .spec.source Description:: + -- @@ -101,7 +103,7 @@ Type:: | Property | Type | Description | `inlineVolumeSpec` -| xref:../objects/index.adoc#persistentvolumespec-core-v1[`PersistentVolumeSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PersistentVolumeSpec[`PersistentVolumeSpec`] | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. | `persistentVolumeName` @@ -109,7 +111,7 @@ Type:: | Name of the persistent volume to attach. |=== -..status +=== .status Description:: + -- @@ -145,7 +147,7 @@ Required:: | VolumeError captures an error encountered during a volume operation. |=== -..status.attachError +=== .status.attachError Description:: + -- @@ -167,11 +169,11 @@ Type:: | String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. | `time` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Time the error was encountered. |=== -..status.detachError +=== .status.detachError Description:: + -- @@ -193,7 +195,7 @@ Type:: | String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. | `time` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Time the error was encountered. |=== @@ -206,11 +208,15 @@ The following API endpoints are available: - `DELETE`: delete collection of VolumeAttachment - `GET`: list or watch objects of kind VolumeAttachment - `POST`: create a VolumeAttachment +* `/apis/storage.k8s.io/v1/watch/volumeattachments` +- `GET`: watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/storage.k8s.io/v1/volumeattachments/{name}` - `DELETE`: delete a VolumeAttachment - `GET`: read the specified VolumeAttachment - `PATCH`: partially update the specified VolumeAttachment - `PUT`: replace the specified VolumeAttachment +* `/apis/storage.k8s.io/v1/watch/volumeattachments/{name}` +- `GET`: watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/storage.k8s.io/v1/volumeattachments/{name}/status` - `GET`: read status of the specified VolumeAttachment - `PATCH`: partially update status of the specified VolumeAttachment @@ -288,7 +294,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -297,7 +303,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -354,7 +362,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#volumeattachmentlist-storage-k8s-io-v1[`VolumeAttachmentList storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.api.storage.v1.VolumeAttachmentList[`VolumeAttachmentList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -381,7 +391,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema | |=== @@ -390,7 +400,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 201 - Created +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 202 - Accepted +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/volumeattachments + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -444,7 +525,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -453,7 +534,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 202 - Accepted +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -468,7 +553,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -498,7 +585,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -507,7 +594,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 201 - Created +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -534,7 +625,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema | |=== @@ -543,7 +634,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 201 - Created +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/storage.k8s.io/v1/watch/volumeattachments/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the VolumeAttachment +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -579,7 +747,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -609,7 +779,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -618,7 +788,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 201 - Created +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -645,7 +819,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema | |=== @@ -654,7 +828,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment storage.k8s.io/v1`] +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 201 - Created +| xref:../storage_apis/volumeattachment-storage-k8s-io-v1.adoc#volumeattachment-storage-k8s-io-v1[`VolumeAttachment`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc b/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc index 159a3163ca71..3d27a16c584d 100644 --- a/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="volumesnapshot-snapshot-storage-k8s-io-v1"] = VolumeSnapshot [snapshot.storage.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object. |=== -..spec +=== .spec Description:: + -- @@ -75,7 +77,7 @@ Required:: | VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field. |=== -..spec.source +=== .spec.source Description:: + -- @@ -101,7 +103,7 @@ Type:: | volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable. |=== -..status +=== .status Description:: + -- @@ -139,7 +141,7 @@ Type:: | restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. |=== -..status.error +=== .status.error Description:: + -- @@ -246,7 +248,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#volumesnapshotlist-snapshot-storage-k8s-io-v1[`VolumeSnapshotList snapshot.storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.storage.snapshot.v1.VolumeSnapshotList[`VolumeSnapshotList`] schema +| 401 - Unauthorized +| Empty |=== @@ -324,7 +328,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -381,7 +387,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#volumesnapshotlist-snapshot-storage-k8s-io-v1[`VolumeSnapshotList snapshot.storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.storage.snapshot.v1.VolumeSnapshotList[`VolumeSnapshotList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -408,7 +416,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema | |=== @@ -417,7 +425,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 202 - Accepted +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== @@ -474,7 +488,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -483,7 +497,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -510,7 +528,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -537,7 +557,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -546,7 +566,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -573,7 +595,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema | |=== @@ -582,7 +604,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== @@ -633,7 +659,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -660,7 +688,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -669,7 +697,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -696,7 +726,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema | |=== @@ -705,7 +735,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc#volumesnapshot-snapshot-storage-k8s-io-v1[`VolumeSnapshot`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc b/rest_api/storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc index 37f71ebc2d3b..b128cffa11e3 100644 --- a/rest_api/storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="volumesnapshotclass-snapshot-storage-k8s-io-v1"] = VolumeSnapshotClass [snapshot.storage.k8s.io/v1] ifdef::product-title[] @@ -44,7 +46,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `parameters` @@ -134,7 +136,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -191,7 +195,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#volumesnapshotclasslist-snapshot-storage-k8s-io-v1[`VolumeSnapshotClassList snapshot.storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.storage.snapshot.v1.VolumeSnapshotClassList[`VolumeSnapshotClassList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -218,7 +224,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema | |=== @@ -227,7 +233,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 202 - Accepted +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 401 - Unauthorized +| Empty |=== @@ -281,7 +293,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -290,7 +302,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -317,7 +333,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -344,7 +362,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -353,7 +371,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -380,7 +400,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema | |=== @@ -389,7 +409,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc#volumesnapshotclass-snapshot-storage-k8s-io-v1[`VolumeSnapshotClass`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc b/rest_api/storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc index 5541c97f6afe..bc19618a3d99 100644 --- a/rest_api/storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc +++ b/rest_api/storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="volumesnapshotcontent-snapshot-storage-k8s-io-v1"] = VolumeSnapshotContent [snapshot.storage.k8s.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta_v2-meta-v1[`ObjectMeta_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2[`ObjectMeta_v2`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -47,7 +49,7 @@ Required:: | status represents the current information of a snapshot. |=== -..spec +=== .spec Description:: + -- @@ -90,7 +92,7 @@ Required:: | volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. |=== -..spec.source +=== .spec.source Description:: + -- @@ -116,7 +118,7 @@ Type:: | volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. |=== -..spec.volumeSnapshotRef +=== .spec.volumeSnapshotRef Description:: + -- @@ -162,7 +164,7 @@ Type:: | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |=== -..status +=== .status Description:: + -- @@ -200,7 +202,7 @@ Type:: | snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. |=== -..status.error +=== .status.error Description:: + -- @@ -312,7 +314,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -369,7 +373,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#volumesnapshotcontentlist-snapshot-storage-k8s-io-v1[`VolumeSnapshotContentList snapshot.storage.k8s.io/v1`] +| xref:../objects/index.adoc#io.k8s.storage.snapshot.v1.VolumeSnapshotContentList[`VolumeSnapshotContentList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -396,7 +402,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema | |=== @@ -405,7 +411,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 202 - Accepted +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== @@ -459,7 +471,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions_v2-meta-v1[`DeleteOptions_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions_v2[`DeleteOptions_v2`] schema | |=== @@ -468,7 +480,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status_v2-meta-v1[`Status_v2 meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2[`Status_v2`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -495,7 +511,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -522,7 +540,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -531,7 +549,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -558,7 +578,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema | |=== @@ -567,7 +587,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== @@ -615,7 +639,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -642,7 +668,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -651,7 +677,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -678,7 +706,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema | |=== @@ -687,7 +715,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent snapshot.storage.k8s.io/v1`] +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 201 - Created +| xref:../storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc#volumesnapshotcontent-snapshot-storage-k8s-io-v1[`VolumeSnapshotContent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/template_apis/brokertemplateinstance-template-openshift-io-v1.adoc b/rest_api/template_apis/brokertemplateinstance-template-openshift-io-v1.adoc index f2a4302e4b01..9d26d5cb68d0 100644 --- a/rest_api/template_apis/brokertemplateinstance-template-openshift-io-v1.adoc +++ b/rest_api/template_apis/brokertemplateinstance-template-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="brokertemplateinstance-template-openshift-io-v1"] = BrokerTemplateInstance [template.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -43,7 +45,7 @@ Required:: | BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance. |=== -..spec +=== .spec Description:: + -- @@ -68,11 +70,11 @@ Required:: | bindingids is a list of 'binding_id's provided during successive bind calls to the template service broker. | `secret` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | secret is a reference to a Secret object residing in a namespace, containing the necessary template parameters. | `templateInstance` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | templateinstance is a reference to a TemplateInstance object residing in a namespace. |=== @@ -85,11 +87,15 @@ The following API endpoints are available: - `DELETE`: delete collection of BrokerTemplateInstance - `GET`: list or watch objects of kind BrokerTemplateInstance - `POST`: create a BrokerTemplateInstance +* `/apis/template.openshift.io/v1/watch/brokertemplateinstances` +- `GET`: watch individual changes to a list of BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/template.openshift.io/v1/brokertemplateinstances/{name}` - `DELETE`: delete a BrokerTemplateInstance - `GET`: read the specified BrokerTemplateInstance - `PATCH`: partially update the specified BrokerTemplateInstance - `PUT`: replace the specified BrokerTemplateInstance +* `/apis/template.openshift.io/v1/watch/brokertemplateinstances/{name}` +- `GET`: watch changes to an object of kind BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/template.openshift.io/v1/brokertemplateinstances @@ -163,7 +169,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -172,7 +178,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -229,7 +237,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#brokertemplateinstancelist-template-openshift-io-v1[`BrokerTemplateInstanceList template.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.template.v1.BrokerTemplateInstanceList[`BrokerTemplateInstanceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -256,7 +266,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema | |=== @@ -265,7 +275,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 201 - Created +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 202 - Accepted +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/brokertemplateinstances + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -319,7 +400,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -328,7 +409,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -343,7 +428,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -373,7 +460,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -382,7 +469,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -409,7 +498,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema | |=== @@ -418,7 +507,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance template.openshift.io/v1`] +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 201 - Created +| xref:../template_apis/brokertemplateinstance-template-openshift-io-v1.adoc#brokertemplateinstance-template-openshift-io-v1[`BrokerTemplateInstance`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/brokertemplateinstances/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the BrokerTemplateInstance +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind BrokerTemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/template_apis/podtemplate-v1.adoc b/rest_api/template_apis/podtemplate-v1.adoc new file mode 100644 index 000000000000..5f79c90a560d --- /dev/null +++ b/rest_api/template_apis/podtemplate-v1.adoc @@ -0,0 +1,9545 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="podtemplate-v1"] += PodTemplate [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +PodTemplate describes a template for creating copies of a predefined pod. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `template` +| `object` +| PodTemplateSpec describes the data a pod should have when created from a template + +|=== +=== .template +Description:: ++ +-- +PodTemplateSpec describes the data a pod should have when created from a template +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| PodSpec is a description of a pod. + +|=== +=== .template.spec +Description:: ++ +-- +PodSpec is a description of a pod. +-- + +Type:: + `object` + +Required:: + - `containers` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `activeDeadlineSeconds` +| `integer` +| Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. + +| `affinity` +| `object` +| Affinity is a group of affinity scheduling rules. + +| `automountServiceAccountToken` +| `boolean` +| AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + +| `containers` +| `array` +| List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + +| `containers[]` +| `object` +| A single application container that you want to run within a pod. + +| `dnsConfig` +| `object` +| PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + +| `dnsPolicy` +| `string` +| Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + +| `enableServiceLinks` +| `boolean` +| EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. + +| `ephemeralContainers` +| `array` +| List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + +| `ephemeralContainers[]` +| `object` +| An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + +| `hostAliases` +| `array` +| HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. + +| `hostAliases[]` +| `object` +| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + +| `hostIPC` +| `boolean` +| Use the host's ipc namespace. Optional: Default to false. + +| `hostNetwork` +| `boolean` +| Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + +| `hostPID` +| `boolean` +| Use the host's pid namespace. Optional: Default to false. + +| `hostname` +| `string` +| Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + +| `imagePullSecrets` +| `array` +| ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + +| `imagePullSecrets[]` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `initContainers` +| `array` +| List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + +| `initContainers[]` +| `object` +| A single application container that you want to run within a pod. + +| `nodeName` +| `string` +| NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + +| `nodeSelector` +| `object (string)` +| NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + +| `overhead` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature. + +| `preemptionPolicy` +| `string` +| PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +| `priority` +| `integer` +| The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + +| `priorityClassName` +| `string` +| If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + +| `readinessGates` +| `array` +| If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + +| `readinessGates[]` +| `object` +| PodReadinessGate contains the reference to a pod condition + +| `restartPolicy` +| `string` +| Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + +| `runtimeClassName` +| `string` +| RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14. + +| `schedulerName` +| `string` +| If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. + +| `securityContext` +| `object` +| PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + +| `serviceAccount` +| `string` +| DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. + +| `serviceAccountName` +| `string` +| ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + +| `setHostnameAsFQDN` +| `boolean` +| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. + +| `shareProcessNamespace` +| `boolean` +| Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + +| `subdomain` +| `string` +| If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + +| `tolerations` +| `array` +| If specified, the pod's tolerations. + +| `tolerations[]` +| `object` +| The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + +| `topologySpreadConstraints` +| `array` +| TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. + +| `topologySpreadConstraints[]` +| `object` +| TopologySpreadConstraint specifies how to spread matching pods among the given topology. + +| `volumes` +| `array` +| List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes + +| `volumes[]` +| `object` +| Volume represents a named volume in a pod that may be accessed by any container in the pod. + +|=== +=== .template.spec.affinity +Description:: ++ +-- +Affinity is a group of affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeAffinity` +| `object` +| Node affinity is a group of node affinity scheduling rules. + +| `podAffinity` +| `object` +| Pod affinity is a group of inter pod affinity scheduling rules. + +| `podAntiAffinity` +| `object` +| Pod anti affinity is a group of inter pod anti affinity scheduling rules. + +|=== +=== .template.spec.affinity.nodeAffinity +Description:: ++ +-- +Node affinity is a group of node affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `object` +| A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + +|=== +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). +-- + +Type:: + `object` + +Required:: + - `weight` + - `preference` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preference` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +| `weight` +| `integer` +| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + +|=== +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +-- + +Type:: + `object` + +Required:: + - `nodeSelectorTerms` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeSelectorTerms` +| `array` +| Required. A list of node selector terms. The terms are ORed. + +| `nodeSelectorTerms[]` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +|=== +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +Description:: ++ +-- +Required. A list of node selector terms. The terms are ORed. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .template.spec.affinity.podAffinity +Description:: ++ +-- +Pod affinity is a group of inter pod affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .template.spec.affinity.podAntiAffinity +Description:: ++ +-- +Pod anti affinity is a group of inter pod anti affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .template.spec.containers +Description:: ++ +-- +List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .template.spec.containers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .template.spec.containers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .template.spec.containers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .template.spec.containers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .template.spec.containers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .template.spec.containers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .template.spec.containers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .template.spec.containers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .template.spec.containers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .template.spec.containers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .template.spec.containers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.containers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.containers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.containers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.containers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.containers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.containers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.containers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.containers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.containers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.containers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.containers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.containers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.containers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .template.spec.containers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.containers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.containers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.containers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.containers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.containers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .template.spec.containers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .template.spec.containers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .template.spec.containers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .template.spec.containers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .template.spec.containers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .template.spec.containers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.containers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.containers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.containers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.containers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.containers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .template.spec.containers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.containers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .template.spec.dnsConfig +Description:: ++ +-- +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nameservers` +| `array (string)` +| A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + +| `options` +| `array` +| A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + +| `options[]` +| `object` +| PodDNSConfigOption defines DNS resolver options of a pod. + +| `searches` +| `array (string)` +| A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + +|=== +=== .template.spec.dnsConfig.options +Description:: ++ +-- +A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. +-- + +Type:: + `array` + + + + +=== .template.spec.dnsConfig.options[] +Description:: ++ +-- +PodDNSConfigOption defines DNS resolver options of a pod. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Required. + +| `value` +| `string` +| + +|=== +=== .template.spec.ephemeralContainers +Description:: ++ +-- +List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[] +Description:: ++ +-- +An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. + +| `ports` +| `array` +| Ports are not allowed for ephemeral containers. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `targetContainerName` +| `string` +| If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .template.spec.ephemeralContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .template.spec.ephemeralContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .template.spec.ephemeralContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .template.spec.ephemeralContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .template.spec.ephemeralContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .template.spec.ephemeralContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .template.spec.ephemeralContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.ephemeralContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.ephemeralContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.ephemeralContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.ephemeralContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.ephemeralContainers[].ports +Description:: ++ +-- +Ports are not allowed for ephemeral containers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .template.spec.ephemeralContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.ephemeralContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.ephemeralContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.ephemeralContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.ephemeralContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .template.spec.ephemeralContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .template.spec.ephemeralContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .template.spec.ephemeralContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .template.spec.ephemeralContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .template.spec.ephemeralContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .template.spec.ephemeralContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.ephemeralContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.ephemeralContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.ephemeralContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.ephemeralContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .template.spec.ephemeralContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.ephemeralContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .template.spec.hostAliases +Description:: ++ +-- +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +-- + +Type:: + `array` + + + + +=== .template.spec.hostAliases[] +Description:: ++ +-- +HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostnames` +| `array (string)` +| Hostnames for the above IP address. + +| `ip` +| `string` +| IP address of the host file entry. + +|=== +=== .template.spec.imagePullSecrets +Description:: ++ +-- +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +-- + +Type:: + `array` + + + + +=== .template.spec.imagePullSecrets[] +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.initContainers +Description:: ++ +-- +List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .template.spec.initContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .template.spec.initContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .template.spec.initContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .template.spec.initContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .template.spec.initContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .template.spec.initContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .template.spec.initContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .template.spec.initContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .template.spec.initContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .template.spec.initContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .template.spec.initContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.initContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.initContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.initContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.initContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .template.spec.initContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.initContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.initContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.initContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.initContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.initContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.initContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.initContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.initContainers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .template.spec.initContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.initContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.initContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.initContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.initContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.initContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .template.spec.initContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .template.spec.initContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .template.spec.initContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .template.spec.initContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .template.spec.initContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .template.spec.initContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .template.spec.initContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .template.spec.initContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .template.spec.initContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .template.spec.initContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .template.spec.initContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .template.spec.initContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .template.spec.initContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .template.spec.readinessGates +Description:: ++ +-- +If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates +-- + +Type:: + `array` + + + + +=== .template.spec.readinessGates[] +Description:: ++ +-- +PodReadinessGate contains the reference to a pod condition +-- + +Type:: + `object` + +Required:: + - `conditionType` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditionType` +| `string` +| ConditionType refers to a condition in the pod's condition list with matching type. + +|=== +=== .template.spec.securityContext +Description:: ++ +-- +PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsGroup` +| `integer` +| A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: + +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- + +If unset, the Kubelet will not modify the ownership and permissions of any volume. + +| `fsGroupChangePolicy` +| `string` +| fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `supplementalGroups` +| `array (integer)` +| A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. + +| `sysctls` +| `array` +| Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. + +| `sysctls[]` +| `object` +| Sysctl defines a kernel parameter to be set + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .template.spec.securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .template.spec.securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .template.spec.securityContext.sysctls +Description:: ++ +-- +Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +-- + +Type:: + `array` + + + + +=== .template.spec.securityContext.sysctls[] +Description:: ++ +-- +Sysctl defines a kernel parameter to be set +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of a property to set + +| `value` +| `string` +| Value of a property to set + +|=== +=== .template.spec.securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .template.spec.tolerations +Description:: ++ +-- +If specified, the pod's tolerations. +-- + +Type:: + `array` + + + + +=== .template.spec.tolerations[] +Description:: ++ +-- +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `effect` +| `string` +| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + +| `key` +| `string` +| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + +| `operator` +| `string` +| Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + +| `tolerationSeconds` +| `integer` +| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + +| `value` +| `string` +| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. + +|=== +=== .template.spec.topologySpreadConstraints +Description:: ++ +-- +TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. +-- + +Type:: + `array` + + + + +=== .template.spec.topologySpreadConstraints[] +Description:: ++ +-- +TopologySpreadConstraint specifies how to spread matching pods among the given topology. +-- + +Type:: + `object` + +Required:: + - `maxSkew` + - `topologyKey` + - `whenUnsatisfiable` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + +| `maxSkew` +| `integer` +| MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: \| zone1 \| zone2 \| zone3 \| \| P \| P \| \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. + +| `topologyKey` +| `string` +| TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + +| `whenUnsatisfiable` +| `string` +| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, + but giving higher precedence to topologies that would help reduce the + skew. +A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + +|=== +=== .template.spec.volumes +Description:: ++ +-- +List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[] +Description:: ++ +-- +Volume represents a named volume in a pod that may be accessed by any container in the pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `awsElasticBlockStore` +| `object` +| Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + +| `azureDisk` +| `object` +| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +| `azureFile` +| `object` +| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +| `cephfs` +| `object` +| Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +| `cinder` +| `object` +| Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +| `configMap` +| `object` +| Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. + +| `csi` +| `object` +| Represents a source location of a volume to mount, managed by an external CSI driver + +| `downwardAPI` +| `object` +| DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. + +| `emptyDir` +| `object` +| Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. + +| `ephemeral` +| `object` +| Represents an ephemeral volume that is handled by a normal storage driver. + +| `fc` +| `object` +| Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + +| `flexVolume` +| `object` +| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +| `flocker` +| `object` +| Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + +| `gcePersistentDisk` +| `object` +| Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + +| `gitRepo` +| `object` +| Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + +| `glusterfs` +| `object` +| Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + +| `hostPath` +| `object` +| Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + +| `iscsi` +| `object` +| Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +| `name` +| `string` +| Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `nfs` +| `object` +| Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + +| `persistentVolumeClaim` +| `object` +| PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + +| `photonPersistentDisk` +| `object` +| Represents a Photon Controller persistent disk resource. + +| `portworxVolume` +| `object` +| PortworxVolumeSource represents a Portworx volume resource. + +| `projected` +| `object` +| Represents a projected volume source + +| `quobyte` +| `object` +| Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + +| `rbd` +| `object` +| Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + +| `scaleIO` +| `object` +| ScaleIOVolumeSource represents a persistent ScaleIO volume + +| `secret` +| `object` +| Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. + +| `storageos` +| `object` +| Represents a StorageOS persistent volume resource. + +| `vsphereVolume` +| `object` +| Represents a vSphere volume resource. + +|=== +=== .template.spec.volumes[].awsElasticBlockStore +Description:: ++ +-- +Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + +| `readOnly` +| `boolean` +| Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `volumeID` +| `string` +| Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +|=== +=== .template.spec.volumes[].azureDisk +Description:: ++ +-- +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `diskName` + - `diskURI` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `cachingMode` +| `string` +| Host Caching mode: None, Read Only, Read Write. + +| `diskName` +| `string` +| The Name of the data disk in the blob storage + +| `diskURI` +| `string` +| The URI the data disk in the blob storage + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `kind` +| `string` +| Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +|=== +=== .template.spec.volumes[].azureFile +Description:: ++ +-- +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `secretName` + - `shareName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretName` +| `string` +| the name of secret that contains Azure Storage Account Name and Key + +| `shareName` +| `string` +| Share Name + +|=== +=== .template.spec.volumes[].cephfs +Description:: ++ +-- +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `monitors` +| `array (string)` +| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `path` +| `string` +| Optional: Used as the mounted root, rather than the full Ceph tree, default is / + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretFile` +| `string` +| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +|=== +=== .template.spec.volumes[].cephfs.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].cinder +Description:: ++ +-- +Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeID` +| `string` +| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +|=== +=== .template.spec.volumes[].cinder.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .template.spec.volumes[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .template.spec.volumes[].csi +Description:: ++ +-- +Represents a source location of a volume to mount, managed by an external CSI driver +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + +| `fsType` +| `string` +| Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + +| `nodePublishSecretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `readOnly` +| `boolean` +| Specifies a read-only configuration for the volume. Defaults to false (read/write). + +| `volumeAttributes` +| `object (string)` +| VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + +|=== +=== .template.spec.volumes[].csi.nodePublishSecretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].downwardAPI +Description:: ++ +-- +DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| Items is a list of downward API volume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .template.spec.volumes[].downwardAPI.items +Description:: ++ +-- +Items is a list of downward API volume file +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .template.spec.volumes[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .template.spec.volumes[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .template.spec.volumes[].emptyDir +Description:: ++ +-- +Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `medium` +| `string` +| What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + +| `sizeLimit` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + +|=== +=== .template.spec.volumes[].ephemeral +Description:: ++ +-- +Represents an ephemeral volume that is handled by a normal storage driver. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `volumeClaimTemplate` +| `object` +| PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + +|=== +=== .template.spec.volumes[].ephemeral.volumeClaimTemplate +Description:: ++ +-- +PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. +-- + +Type:: + `object` + +Required:: + - `spec` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + +| `spec` +| `object` +| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + +|=== +=== .template.spec.volumes[].ephemeral.volumeClaimTemplate.spec +Description:: ++ +-- +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +| `dataSource` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `dataSourceRef` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `selector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over volumes to consider for binding. + +| `storageClassName` +| `string` +| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + +| `volumeMode` +| `string` +| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + +| `volumeName` +| `string` +| VolumeName is the binding reference to the PersistentVolume backing this claim. + +|=== +=== .template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .template.spec.volumes[].fc +Description:: ++ +-- +Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `lun` +| `integer` +| Optional: FC target lun number + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `targetWWNs` +| `array (string)` +| Optional: FC target worldwide names (WWNs) + +| `wwids` +| `array (string)` +| Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + +|=== +=== .template.spec.volumes[].flexVolume +Description:: ++ +-- +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the driver to use for this volume. + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +| `options` +| `object (string)` +| Optional: Extra command options if any. + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +|=== +=== .template.spec.volumes[].flexVolume.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].flocker +Description:: ++ +-- +Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `datasetName` +| `string` +| Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + +| `datasetUUID` +| `string` +| UUID of the dataset. This is unique identifier of a Flocker dataset + +|=== +=== .template.spec.volumes[].gcePersistentDisk +Description:: ++ +-- +Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `pdName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `pdName` +| `string` +| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +|=== +=== .template.spec.volumes[].gitRepo +Description:: ++ +-- +Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. +-- + +Type:: + `object` + +Required:: + - `repository` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `directory` +| `string` +| Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + +| `repository` +| `string` +| Repository URL + +| `revision` +| `string` +| Commit hash for the specified revision. + +|=== +=== .template.spec.volumes[].glusterfs +Description:: ++ +-- +Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `endpoints` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `endpoints` +| `string` +| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `path` +| `string` +| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `readOnly` +| `boolean` +| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +|=== +=== .template.spec.volumes[].hostPath +Description:: ++ +-- +Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +| `type` +| `string` +| Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +|=== +=== .template.spec.volumes[].iscsi +Description:: ++ +-- +Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `targetPortal` + - `iqn` + - `lun` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `chapAuthDiscovery` +| `boolean` +| whether support iSCSI Discovery CHAP authentication + +| `chapAuthSession` +| `boolean` +| whether support iSCSI Session CHAP authentication + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +| `initiatorName` +| `string` +| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +| `iqn` +| `string` +| Target iSCSI Qualified Name. + +| `iscsiInterface` +| `string` +| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + +| `lun` +| `integer` +| iSCSI Target Lun number. + +| `portals` +| `array (string)` +| iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `targetPortal` +| `string` +| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +|=== +=== .template.spec.volumes[].iscsi.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].nfs +Description:: ++ +-- +Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `server` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `readOnly` +| `boolean` +| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `server` +| `string` +| Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +|=== +=== .template.spec.volumes[].persistentVolumeClaim +Description:: ++ +-- +PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). +-- + +Type:: + `object` + +Required:: + - `claimName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `claimName` +| `string` +| ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +| `readOnly` +| `boolean` +| Will force the ReadOnly setting in VolumeMounts. Default false. + +|=== +=== .template.spec.volumes[].photonPersistentDisk +Description:: ++ +-- +Represents a Photon Controller persistent disk resource. +-- + +Type:: + `object` + +Required:: + - `pdID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `pdID` +| `string` +| ID that identifies Photon Controller persistent disk + +|=== +=== .template.spec.volumes[].portworxVolume +Description:: ++ +-- +PortworxVolumeSource represents a Portworx volume resource. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `volumeID` +| `string` +| VolumeID uniquely identifies a Portworx volume + +|=== +=== .template.spec.volumes[].projected +Description:: ++ +-- +Represents a projected volume source +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `sources` +| `array` +| list of volume projections + +| `sources[]` +| `object` +| Projection that may be projected along with other supported volume types + +|=== +=== .template.spec.volumes[].projected.sources +Description:: ++ +-- +list of volume projections +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].projected.sources[] +Description:: ++ +-- +Projection that may be projected along with other supported volume types +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. + +| `downwardAPI` +| `object` +| Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. + +| `secret` +| `object` +| Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. + +| `serviceAccountToken` +| `object` +| ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + +|=== +=== .template.spec.volumes[].projected.sources[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .template.spec.volumes[].projected.sources[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].projected.sources[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .template.spec.volumes[].projected.sources[].downwardAPI +Description:: ++ +-- +Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| Items is a list of DownwardAPIVolume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .template.spec.volumes[].projected.sources[].downwardAPI.items +Description:: ++ +-- +Items is a list of DownwardAPIVolume file +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].projected.sources[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .template.spec.volumes[].projected.sources[].secret +Description:: ++ +-- +Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .template.spec.volumes[].projected.sources[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].projected.sources[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .template.spec.volumes[].projected.sources[].serviceAccountToken +Description:: ++ +-- +ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `audience` +| `string` +| Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + +| `expirationSeconds` +| `integer` +| ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + +| `path` +| `string` +| Path is the path relative to the mount point of the file to project the token into. + +|=== +=== .template.spec.volumes[].quobyte +Description:: ++ +-- +Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `registry` + - `volume` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `group` +| `string` +| Group to map volume access to Default is no group + +| `readOnly` +| `boolean` +| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + +| `registry` +| `string` +| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + +| `tenant` +| `string` +| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + +| `user` +| `string` +| User to map volume access to Defaults to serivceaccount user + +| `volume` +| `string` +| Volume is a string that references an already created Quobyte volume by name. + +|=== +=== .template.spec.volumes[].rbd +Description:: ++ +-- +Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + - `image` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +| `image` +| `string` +| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `keyring` +| `string` +| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `monitors` +| `array (string)` +| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `pool` +| `string` +| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +|=== +=== .template.spec.volumes[].rbd.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].scaleIO +Description:: ++ +-- +ScaleIOVolumeSource represents a persistent ScaleIO volume +-- + +Type:: + `object` + +Required:: + - `gateway` + - `system` + - `secretRef` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + +| `gateway` +| `string` +| The host address of the ScaleIO API Gateway. + +| `protectionDomain` +| `string` +| The name of the ScaleIO Protection Domain for the configured storage. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `sslEnabled` +| `boolean` +| Flag to enable/disable SSL communication with Gateway, default false + +| `storageMode` +| `string` +| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + +| `storagePool` +| `string` +| The ScaleIO Storage Pool associated with the protection domain. + +| `system` +| `string` +| The name of the storage system as configured in ScaleIO. + +| `volumeName` +| `string` +| The name of a volume already created in the ScaleIO system that is associated with this volume source. + +|=== +=== .template.spec.volumes[].scaleIO.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].secret +Description:: ++ +-- +Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `optional` +| `boolean` +| Specify whether the Secret or its keys must be defined + +| `secretName` +| `string` +| Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + +|=== +=== .template.spec.volumes[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .template.spec.volumes[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .template.spec.volumes[].storageos +Description:: ++ +-- +Represents a StorageOS persistent volume resource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeName` +| `string` +| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + +| `volumeNamespace` +| `string` +| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +|=== +=== .template.spec.volumes[].storageos.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .template.spec.volumes[].vsphereVolume +Description:: ++ +-- +Represents a vSphere volume resource. +-- + +Type:: + `object` + +Required:: + - `volumePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `storagePolicyID` +| `string` +| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + +| `storagePolicyName` +| `string` +| Storage Policy Based Management (SPBM) profile name. + +| `volumePath` +| `string` +| Path that identifies vSphere volume vmdk + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/podtemplates` +- `GET`: list or watch objects of kind PodTemplate +* `/api/v1/watch/podtemplates` +- `GET`: watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/podtemplates` +- `DELETE`: delete collection of PodTemplate +- `GET`: list or watch objects of kind PodTemplate +- `POST`: create a PodTemplate +* `/api/v1/watch/namespaces/{namespace}/podtemplates` +- `GET`: watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/podtemplates/{name}` +- `DELETE`: delete a PodTemplate +- `GET`: read the specified PodTemplate +- `PATCH`: partially update the specified PodTemplate +- `PUT`: replace the specified PodTemplate +* `/api/v1/watch/namespaces/{namespace}/podtemplates/{name}` +- `GET`: watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /api/v1/podtemplates + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind PodTemplate + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateList[`PodTemplateList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/podtemplates + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/podtemplates + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateList[`PodTemplateList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 201 - Created +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 202 - Accepted +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/podtemplates + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/podtemplates/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PodTemplate +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 202 - Accepted +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified PodTemplate + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 201 - Created +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified PodTemplate + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 201 - Created +| xref:../template_apis/podtemplate-v1.adoc#podtemplate-v1[`PodTemplate`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/podtemplates/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PodTemplate +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/template_apis/template-apis-index.adoc b/rest_api/template_apis/template-apis-index.adoc index 818b9e322e71..2c1c806d5005 100644 --- a/rest_api/template_apis/template-apis-index.adoc +++ b/rest_api/template_apis/template-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="template-apis"] = Template APIs ifdef::product-title[] @@ -17,7 +19,7 @@ BrokerTemplateInstance holds the service broker-related state associated with a Type:: `object` -== PodTemplate [core/v1] +== PodTemplate [v1] Description:: + diff --git a/rest_api/template_apis/template-template-openshift-io-v1.adoc b/rest_api/template_apis/template-template-openshift-io-v1.adoc index a01970c22c79..c86e3258e0d3 100644 --- a/rest_api/template_apis/template-template-openshift-io-v1.adoc +++ b/rest_api/template_apis/template-template-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="template-template-openshift-io-v1"] = Template [template.openshift.io/v1] ifdef::product-title[] @@ -43,11 +45,11 @@ Required:: | message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output. | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `objects` -| xref:../objects/index.adoc#rawextension-pkg-none[`array (RawExtension pkg/none)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`array (RawExtension)`] | objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace. | `parameters` @@ -59,7 +61,7 @@ Required:: | Parameter defines a name/value variable that is to be processed during the Template to Config transformation. |=== -..parameters +=== .parameters Description:: + -- @@ -72,7 +74,7 @@ Type:: -..parameters[] +=== .parameters[] Description:: + -- @@ -131,8 +133,591 @@ from \| value ----------------------------- "test[0-9]{1}x" \| "tes The following API endpoints are available: +* `/apis/template.openshift.io/v1/templates` +- `GET`: list or watch objects of kind Template +* `/apis/template.openshift.io/v1/watch/templates` +- `GET`: watch individual changes to a list of Template. deprecated: use the 'watch' parameter with a list operation instead. +* `/apis/template.openshift.io/v1/namespaces/{namespace}/templates` +- `DELETE`: delete collection of Template +- `GET`: list or watch objects of kind Template +- `POST`: create a Template +* `/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates` +- `GET`: watch individual changes to a list of Template. deprecated: use the 'watch' parameter with a list operation instead. +* `/apis/template.openshift.io/v1/namespaces/{namespace}/templates/{name}` +- `DELETE`: delete a Template +- `GET`: read the specified Template +- `PATCH`: partially update the specified Template +- `PUT`: replace the specified Template * `/apis/template.openshift.io/v1/namespaces/{namespace}/processedtemplates` - `POST`: create a Template +* `/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates/{name}` +- `GET`: watch changes to an object of kind Template. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /apis/template.openshift.io/v1/templates + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Template + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#com.github.openshift.api.template.v1.TemplateList[`TemplateList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/templates + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Template. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/namespaces/{namespace}/templates + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#com.github.openshift.api.template.v1.TemplateList[`TemplateList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 201 - Created +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 202 - Accepted +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Template. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/namespaces/{namespace}/templates/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Template +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 202 - Accepted +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Template + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Template + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 201 - Created +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== === /apis/template.openshift.io/v1/namespaces/{namespace}/processedtemplates @@ -174,7 +759,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template template.openshift.io/v1`] +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema | |=== @@ -183,7 +768,89 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template template.openshift.io/v1`] +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 201 - Created +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 202 - Accepted +| xref:../template_apis/template-template-openshift-io-v1.adoc#template-template-openshift-io-v1[`Template`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templates/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Template +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Template. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc b/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc index eb19b69f2bbc..5a6b96ecb416 100644 --- a/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc +++ b/rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="templateinstance-template-openshift-io-v1"] = TemplateInstance [template.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -47,7 +49,7 @@ Required:: | TemplateInstanceStatus describes the current state of a TemplateInstance. |=== -..spec +=== .spec Description:: + -- @@ -71,7 +73,7 @@ Required:: | TemplateInstanceRequester holds the identity of an agent requesting a template instantiation. | `secret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | secret is a reference to a Secret object containing the necessary template parameters. | `template` @@ -79,7 +81,7 @@ Required:: | Template contains the inputs needed to produce a Config. |=== -..spec.requester +=== .spec.requester Description:: + -- @@ -117,7 +119,7 @@ Type:: | username uniquely identifies this user among all active users. |=== -..spec.requester.extra +=== .spec.requester.extra Description:: + -- @@ -130,7 +132,7 @@ Type:: -..spec.template +=== .spec.template Description:: + -- @@ -166,11 +168,11 @@ Required:: | message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output. | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `objects` -| xref:../objects/index.adoc#rawextension-pkg-none[`array (RawExtension pkg/none)`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.runtime.RawExtension[`array (RawExtension)`] | objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace. | `parameters` @@ -182,7 +184,7 @@ Required:: | Parameter defines a name/value variable that is to be processed during the Template to Config transformation. |=== -..spec.template.parameters +=== .spec.template.parameters Description:: + -- @@ -195,7 +197,7 @@ Type:: -..spec.template.parameters[] +=== .spec.template.parameters[] Description:: + -- @@ -249,7 +251,7 @@ from \| value ----------------------------- "test[0-9]{1}x" \| "tes | Value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional. |=== -..status +=== .status Description:: + -- @@ -283,7 +285,7 @@ Type:: | TemplateInstanceObject references an object created by a TemplateInstance. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -296,7 +298,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -320,7 +322,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | LastTransitionTime is the last time a condition status transitioned from one state to another. | `message` @@ -340,7 +342,7 @@ Required:: | Type of the condition, currently Ready or InstantiateFailure. |=== -..status.objects +=== .status.objects Description:: + -- @@ -353,7 +355,7 @@ Type:: -..status.objects[] +=== .status.objects[] Description:: + -- @@ -371,7 +373,7 @@ Type:: | Property | Type | Description | `ref` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | ref is a reference to the created object. When used under .spec, only name and namespace are used; these can contain references to parameters which will be substituted following the usual rules. |=== @@ -382,15 +384,21 @@ The following API endpoints are available: * `/apis/template.openshift.io/v1/templateinstances` - `GET`: list or watch objects of kind TemplateInstance +* `/apis/template.openshift.io/v1/watch/templateinstances` +- `GET`: watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances` - `DELETE`: delete collection of TemplateInstance - `GET`: list or watch objects of kind TemplateInstance - `POST`: create a TemplateInstance +* `/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances` +- `GET`: watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}` - `DELETE`: delete a TemplateInstance - `GET`: read the specified TemplateInstance - `PATCH`: partially update the specified TemplateInstance - `PUT`: replace the specified TemplateInstance +* `/apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name}` +- `GET`: watch changes to an object of kind TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/template.openshift.io/v1/namespaces/{namespace}/templateinstances/{name}/status` - `GET`: read status of the specified TemplateInstance - `PATCH`: partially update status of the specified TemplateInstance @@ -456,7 +464,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#templateinstancelist-template-openshift-io-v1[`TemplateInstanceList template.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.template.v1.TemplateInstanceList[`TemplateInstanceList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/templateinstances + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -539,7 +614,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -548,7 +623,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -605,7 +682,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#templateinstancelist-template-openshift-io-v1[`TemplateInstanceList template.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.template.v1.TemplateInstanceList[`TemplateInstanceList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -632,7 +711,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema | |=== @@ -641,7 +720,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 201 - Created +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 202 - Accepted +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -698,7 +856,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -707,7 +865,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -722,7 +884,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -752,7 +916,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -761,7 +925,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -788,7 +954,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema | |=== @@ -797,7 +963,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 201 - Created +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/template.openshift.io/v1/watch/namespaces/{namespace}/templateinstances/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the TemplateInstance +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind TemplateInstance. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -836,7 +1082,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -866,7 +1114,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -875,7 +1123,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -902,7 +1152,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema | |=== @@ -911,7 +1161,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance template.openshift.io/v1`] +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 201 - Created +| xref:../template_apis/templateinstance-template-openshift-io-v1.adoc#templateinstance-template-openshift-io-v1[`TemplateInstance`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/user_and_group_apis/group-user-openshift-io-v1.adoc b/rest_api/user_and_group_apis/group-user-openshift-io-v1.adoc index 541f0757b287..e2b8dedb0bfd 100644 --- a/rest_api/user_and_group_apis/group-user-openshift-io-v1.adoc +++ b/rest_api/user_and_group_apis/group-user-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="group-user-openshift-io-v1"] = Group [user.openshift.io/v1] ifdef::product-title[] @@ -35,7 +37,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `users` @@ -52,11 +54,15 @@ The following API endpoints are available: - `DELETE`: delete collection of Group - `GET`: list or watch objects of kind Group - `POST`: create a Group +* `/apis/user.openshift.io/v1/watch/groups` +- `GET`: watch individual changes to a list of Group. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/user.openshift.io/v1/groups/{name}` - `DELETE`: delete a Group - `GET`: read the specified Group - `PATCH`: partially update the specified Group - `PUT`: replace the specified Group +* `/apis/user.openshift.io/v1/watch/groups/{name}` +- `GET`: watch changes to an object of kind Group. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/user.openshift.io/v1/groups @@ -130,7 +136,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -139,7 +145,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -196,7 +204,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#grouplist-user-openshift-io-v1[`GroupList user.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.user.v1.GroupList[`GroupList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -223,7 +233,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema | |=== @@ -232,7 +242,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 201 - Created +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 202 - Accepted +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/groups + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Group. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -286,7 +367,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -295,7 +376,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -310,7 +395,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -340,7 +427,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -349,7 +436,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -376,7 +465,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema | |=== @@ -385,7 +474,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group user.openshift.io/v1`] +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 201 - Created +| xref:../user_and_group_apis/group-user-openshift-io-v1.adoc#group-user-openshift-io-v1[`Group`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/groups/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Group +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Group. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/user_and_group_apis/identity-user-openshift-io-v1.adoc b/rest_api/user_and_group_apis/identity-user-openshift-io-v1.adoc index 17fdeaa8f8a9..f773a69b8a4b 100644 --- a/rest_api/user_and_group_apis/identity-user-openshift-io-v1.adoc +++ b/rest_api/user_and_group_apis/identity-user-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="identity-user-openshift-io-v1"] = Identity [user.openshift.io/v1] ifdef::product-title[] @@ -41,7 +43,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `providerName` @@ -53,7 +55,7 @@ Required:: | ProviderUserName uniquely represents this identity in the scope of the provider | `user` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | User is a reference to the user this identity is associated with Both Name and UID must be set |=== @@ -66,11 +68,15 @@ The following API endpoints are available: - `DELETE`: delete collection of Identity - `GET`: list or watch objects of kind Identity - `POST`: create an Identity +* `/apis/user.openshift.io/v1/watch/identities` +- `GET`: watch individual changes to a list of Identity. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/user.openshift.io/v1/identities/{name}` - `DELETE`: delete an Identity - `GET`: read the specified Identity - `PATCH`: partially update the specified Identity - `PUT`: replace the specified Identity +* `/apis/user.openshift.io/v1/watch/identities/{name}` +- `GET`: watch changes to an object of kind Identity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/user.openshift.io/v1/identities @@ -144,7 +150,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -153,7 +159,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -210,7 +218,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#identitylist-user-openshift-io-v1[`IdentityList user.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.user.v1.IdentityList[`IdentityList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -237,7 +247,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema | |=== @@ -246,7 +256,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 201 - Created +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 202 - Accepted +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/identities + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Identity. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -300,7 +381,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -309,7 +390,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -324,7 +409,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -354,7 +441,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -363,7 +450,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -390,7 +479,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema | |=== @@ -399,7 +488,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity user.openshift.io/v1`] +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 201 - Created +| xref:../user_and_group_apis/identity-user-openshift-io-v1.adoc#identity-user-openshift-io-v1[`Identity`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/identities/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Identity +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Identity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/user_and_group_apis/user-and-group-apis-index.adoc b/rest_api/user_and_group_apis/user-and-group-apis-index.adoc index 7baa0f22875e..1d85e4405b6a 100644 --- a/rest_api/user_and_group_apis/user-and-group-apis-index.adoc +++ b/rest_api/user_and_group_apis/user-and-group-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="user-and-group-apis"] = User and group APIs ifdef::product-title[] diff --git a/rest_api/user_and_group_apis/user-user-openshift-io-v1.adoc b/rest_api/user_and_group_apis/user-user-openshift-io-v1.adoc index 7ede99ccd8ec..e4517c4fa081 100644 --- a/rest_api/user_and_group_apis/user-user-openshift-io-v1.adoc +++ b/rest_api/user_and_group_apis/user-user-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="user-user-openshift-io-v1"] = User [user.openshift.io/v1] ifdef::product-title[] @@ -47,7 +49,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | |=== @@ -60,11 +62,15 @@ The following API endpoints are available: - `DELETE`: delete collection of User - `GET`: list or watch objects of kind User - `POST`: create an User +* `/apis/user.openshift.io/v1/watch/users` +- `GET`: watch individual changes to a list of User. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/user.openshift.io/v1/users/{name}` - `DELETE`: delete an User - `GET`: read the specified User - `PATCH`: partially update the specified User - `PUT`: replace the specified User +* `/apis/user.openshift.io/v1/watch/users/{name}` +- `GET`: watch changes to an object of kind User. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/user.openshift.io/v1/users @@ -138,7 +144,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -147,7 +153,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -204,7 +212,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#userlist-user-openshift-io-v1[`UserList user.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.user.v1.UserList[`UserList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -231,7 +241,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema | |=== @@ -240,7 +250,78 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 201 - Created +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 202 - Accepted +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/users + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of User. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -294,7 +375,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -303,7 +384,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -318,7 +403,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -348,7 +435,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -357,7 +444,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -384,7 +473,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema | |=== @@ -393,7 +482,84 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User user.openshift.io/v1`] +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 201 - Created +| xref:../user_and_group_apis/user-user-openshift-io-v1.adoc#user-user-openshift-io-v1[`User`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/user.openshift.io/v1/watch/users/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the User +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind User. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc b/rest_api/user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc index 0d94bdbdc8d2..7ab1fc4a084f 100644 --- a/rest_api/user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc +++ b/rest_api/user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="useridentitymapping-user-openshift-io-v1"] = UserIdentityMapping [user.openshift.io/v1] ifdef::product-title[] @@ -29,7 +31,7 @@ Type:: | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `identity` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | Identity is a reference to an identity | `kind` @@ -37,11 +39,11 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `user` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | User is a reference to a user |=== @@ -90,7 +92,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema | |=== @@ -99,7 +101,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 201 - Created +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 202 - Accepted +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 401 - Unauthorized +| Empty |=== @@ -153,7 +161,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -162,7 +170,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -177,7 +189,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -207,7 +221,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -216,7 +230,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -243,7 +259,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema | |=== @@ -252,7 +268,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping user.openshift.io/v1`] +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 201 - Created +| xref:../user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc#useridentitymapping-user-openshift-io-v1[`UserIdentityMapping`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/build-build-openshift-io-v1.adoc b/rest_api/workloads_apis/build-build-openshift-io-v1.adoc index 50cb64c4f4cc..929cc3fa3795 100644 --- a/rest_api/workloads_apis/build-build-openshift-io-v1.adoc +++ b/rest_api/workloads_apis/build-build-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="build-build-openshift-io-v1"] = Build [build.openshift.io/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -45,7 +47,7 @@ Type:: | BuildStatus contains the status of a build |=== -..spec +=== .spec Description:: + -- @@ -143,7 +145,7 @@ There are five different ways to configure the hook. As an example, all forms be It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed. | `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceRequirements[`ResourceRequirements`] | resources computes resource requirements to execute the build. | `revision` @@ -171,7 +173,7 @@ It is invalid to provide both Script and Command simultaneously. If none of the | BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration. |=== -..spec.output +=== .spec.output Description:: + -- @@ -197,15 +199,15 @@ Type:: | ImageLabel represents a label applied to the resulting image. | `pushSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | to defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a container image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified. |=== -..spec.output.imageLabels +=== .spec.output.imageLabels Description:: + -- @@ -218,7 +220,7 @@ Type:: -..spec.output.imageLabels[] +=== .spec.output.imageLabels[] Description:: + -- @@ -246,7 +248,7 @@ Required:: | value defines the literal value of the label. |=== -..spec.postCommit +=== .spec.postCommit Description:: + -- @@ -332,7 +334,7 @@ Type:: | script is a shell script to be run with `/bin/sh -ic`. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with `rake test`. If you need control over the image entrypoint, or if the image does not have `/bin/sh`, use Command and/or Args. The `-i` flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make `ruby`, `bundle` and other binaries available in the PATH. |=== -..spec.revision +=== .spec.revision Description:: + -- @@ -360,7 +362,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.revision.git +=== .spec.revision.git Description:: + -- @@ -394,7 +396,7 @@ Type:: | message is the description of a specific commit |=== -..spec.revision.git.author +=== .spec.revision.git.author Description:: + -- @@ -420,7 +422,7 @@ Type:: | name of the source control user |=== -..spec.revision.git.committer +=== .spec.revision.git.committer Description:: + -- @@ -446,7 +448,7 @@ Type:: | name of the source control user |=== -..spec.source +=== .spec.source Description:: + -- @@ -504,7 +506,7 @@ Type:: | SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. | `sourceSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. | `type` @@ -512,7 +514,7 @@ Type:: | type of build input to accept |=== -..spec.source.binary +=== .spec.source.binary Description:: + -- @@ -534,7 +536,7 @@ Type:: | asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as `/webapp.war` for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'. |=== -..spec.source.configMaps +=== .spec.source.configMaps Description:: + -- @@ -547,7 +549,7 @@ Type:: -..spec.source.configMaps[] +=== .spec.source.configMaps[] Description:: + -- @@ -567,7 +569,7 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | configMap is a reference to an existing configmap that you want to use in your build. | `destinationDir` @@ -575,7 +577,7 @@ Required:: | destinationDir is the directory where the files from the configmap should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. |=== -..spec.source.git +=== .spec.source.git Description:: + -- @@ -615,7 +617,7 @@ Required:: | uri points to the source that will be built. The structure of the source will depend on the type of build to run |=== -..spec.source.images +=== .spec.source.images Description:: + -- @@ -628,7 +630,7 @@ Type:: -..spec.source.images[] +=== .spec.source.images[] Description:: + -- @@ -652,7 +654,7 @@ Required:: | A list of image names that this source will be used in place of during a multi-stage container image build. For instance, a Dockerfile that uses "COPY --from=nginx:latest" will first check for an image source that has "nginx:latest" in this field before attempting to pull directly. If the Dockerfile does not reference an image source it is ignored. This field and paths may both be set, in which case the contents will be used twice. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from. | `paths` @@ -664,11 +666,11 @@ Required:: | ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. |=== -..spec.source.images[].paths +=== .spec.source.images[].paths Description:: + -- @@ -681,7 +683,7 @@ Type:: -..spec.source.images[].paths[] +=== .spec.source.images[].paths[] Description:: + -- @@ -710,7 +712,7 @@ Required:: | sourcePath is the absolute path of the file or directory inside the image to copy to the build directory. If the source path ends in /. then the content of the directory will be copied, but the directory itself will not be created at the destination. |=== -..spec.source.secrets +=== .spec.source.secrets Description:: + -- @@ -723,7 +725,7 @@ Type:: -..spec.source.secrets[] +=== .spec.source.secrets[] Description:: + -- @@ -747,11 +749,11 @@ Required:: | destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. | `secret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | secret is a reference to an existing secret that you want to use in your build. |=== -..spec.strategy +=== .spec.strategy Description:: + -- @@ -789,7 +791,7 @@ Type:: | type is the kind of build strategy. |=== -..spec.strategy.customStrategy +=== .spec.strategy.customStrategy Description:: + -- @@ -813,7 +815,7 @@ Required:: | buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `exposeDockerSocket` @@ -825,11 +827,11 @@ Required:: | forcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `secrets` @@ -841,7 +843,7 @@ Required:: | SecretSpec specifies a secret to be included in a build pod and its corresponding mount point |=== -..spec.strategy.customStrategy.secrets +=== .spec.strategy.customStrategy.secrets Description:: + -- @@ -854,7 +856,7 @@ Type:: -..spec.strategy.customStrategy.secrets[] +=== .spec.strategy.customStrategy.secrets[] Description:: + -- @@ -879,11 +881,11 @@ Required:: | mountPath is the path at which to mount the secret | `secretSource` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | secretSource is a reference to the secret |=== -..spec.strategy.dockerStrategy +=== .spec.strategy.dockerStrategy Description:: + -- @@ -901,7 +903,7 @@ Type:: | Property | Type | Description | `buildArgs` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details. NOTE: Only the 'name' and 'value' fields are supported. Any settings on the 'valueFrom' field are ignored. | `dockerfilePath` @@ -909,7 +911,7 @@ Type:: | dockerfilePath is the path of the Dockerfile that will be used to build the container image, relative to the root of the context (contextDir). Defaults to `Dockerfile` if unset. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `forcePull` @@ -917,7 +919,7 @@ Type:: | forcePull describes if the builder should pull the images from registry prior to building. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file. | `imageOptimizationPolicy` @@ -929,7 +931,7 @@ Type:: | noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `volumes` @@ -941,7 +943,7 @@ Type:: | BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. |=== -..spec.strategy.dockerStrategy.volumes +=== .spec.strategy.dockerStrategy.volumes Description:: + -- @@ -954,7 +956,7 @@ Type:: -..spec.strategy.dockerStrategy.volumes[] +=== .spec.strategy.dockerStrategy.volumes[] Description:: + -- @@ -992,7 +994,7 @@ Required:: | BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |=== -..spec.strategy.dockerStrategy.volumes[].mounts +=== .spec.strategy.dockerStrategy.volumes[].mounts Description:: + -- @@ -1005,7 +1007,7 @@ Type:: -..spec.strategy.dockerStrategy.volumes[].mounts[] +=== .spec.strategy.dockerStrategy.volumes[].mounts[] Description:: + -- @@ -1029,7 +1031,7 @@ Required:: | destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |=== -..spec.strategy.dockerStrategy.volumes[].source +=== .spec.strategy.dockerStrategy.volumes[].source Description:: + -- @@ -1049,11 +1051,11 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#configmapvolumesource-core-v1[`ConfigMapVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapVolumeSource[`ConfigMapVolumeSource`] | configMap represents a ConfigMap that should populate this volume | `secret` -| xref:../objects/index.adoc#secretvolumesource-core-v1[`SecretVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretVolumeSource[`SecretVolumeSource`] | secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | `type` @@ -1061,7 +1063,7 @@ Required:: | type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |=== -..spec.strategy.jenkinsPipelineStrategy +=== .spec.strategy.jenkinsPipelineStrategy Description:: + -- @@ -1079,7 +1081,7 @@ Type:: | Property | Type | Description | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a build pipeline. | `jenkinsfile` @@ -1091,7 +1093,7 @@ Type:: | JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir. |=== -..spec.strategy.sourceStrategy +=== .spec.strategy.sourceStrategy Description:: + -- @@ -1111,7 +1113,7 @@ Required:: | Property | Type | Description | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `forcePull` @@ -1119,7 +1121,7 @@ Required:: | forcePull describes if the builder should pull the images from registry prior to building. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `incremental` @@ -1127,7 +1129,7 @@ Required:: | incremental flag forces the Source build to do incremental builds if true. | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `scripts` @@ -1143,7 +1145,7 @@ Required:: | BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. |=== -..spec.strategy.sourceStrategy.volumes +=== .spec.strategy.sourceStrategy.volumes Description:: + -- @@ -1156,7 +1158,7 @@ Type:: -..spec.strategy.sourceStrategy.volumes[] +=== .spec.strategy.sourceStrategy.volumes[] Description:: + -- @@ -1194,7 +1196,7 @@ Required:: | BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |=== -..spec.strategy.sourceStrategy.volumes[].mounts +=== .spec.strategy.sourceStrategy.volumes[].mounts Description:: + -- @@ -1207,7 +1209,7 @@ Type:: -..spec.strategy.sourceStrategy.volumes[].mounts[] +=== .spec.strategy.sourceStrategy.volumes[].mounts[] Description:: + -- @@ -1231,7 +1233,7 @@ Required:: | destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |=== -..spec.strategy.sourceStrategy.volumes[].source +=== .spec.strategy.sourceStrategy.volumes[].source Description:: + -- @@ -1251,11 +1253,11 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#configmapvolumesource-core-v1[`ConfigMapVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapVolumeSource[`ConfigMapVolumeSource`] | configMap represents a ConfigMap that should populate this volume | `secret` -| xref:../objects/index.adoc#secretvolumesource-core-v1[`SecretVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretVolumeSource[`SecretVolumeSource`] | secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | `type` @@ -1263,7 +1265,7 @@ Required:: | type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |=== -..spec.triggeredBy +=== .spec.triggeredBy Description:: + -- @@ -1276,7 +1278,7 @@ Type:: -..spec.triggeredBy[] +=== .spec.triggeredBy[] Description:: + -- @@ -1318,7 +1320,7 @@ Type:: | message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc. |=== -..spec.triggeredBy[].bitbucketWebHook +=== .spec.triggeredBy[].bitbucketWebHook Description:: + -- @@ -1344,7 +1346,7 @@ Type:: | Secret is the obfuscated webhook secret that triggered a build. |=== -..spec.triggeredBy[].bitbucketWebHook.revision +=== .spec.triggeredBy[].bitbucketWebHook.revision Description:: + -- @@ -1372,7 +1374,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.triggeredBy[].bitbucketWebHook.revision.git +=== .spec.triggeredBy[].bitbucketWebHook.revision.git Description:: + -- @@ -1406,7 +1408,7 @@ Type:: | message is the description of a specific commit |=== -..spec.triggeredBy[].bitbucketWebHook.revision.git.author +=== .spec.triggeredBy[].bitbucketWebHook.revision.git.author Description:: + -- @@ -1432,7 +1434,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].bitbucketWebHook.revision.git.committer +=== .spec.triggeredBy[].bitbucketWebHook.revision.git.committer Description:: + -- @@ -1458,7 +1460,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].genericWebHook +=== .spec.triggeredBy[].genericWebHook Description:: + -- @@ -1484,7 +1486,7 @@ Type:: | secret is the obfuscated webhook secret that triggered a build. |=== -..spec.triggeredBy[].genericWebHook.revision +=== .spec.triggeredBy[].genericWebHook.revision Description:: + -- @@ -1512,7 +1514,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.triggeredBy[].genericWebHook.revision.git +=== .spec.triggeredBy[].genericWebHook.revision.git Description:: + -- @@ -1546,7 +1548,7 @@ Type:: | message is the description of a specific commit |=== -..spec.triggeredBy[].genericWebHook.revision.git.author +=== .spec.triggeredBy[].genericWebHook.revision.git.author Description:: + -- @@ -1572,7 +1574,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].genericWebHook.revision.git.committer +=== .spec.triggeredBy[].genericWebHook.revision.git.committer Description:: + -- @@ -1598,7 +1600,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].githubWebHook +=== .spec.triggeredBy[].githubWebHook Description:: + -- @@ -1624,7 +1626,7 @@ Type:: | secret is the obfuscated webhook secret that triggered a build. |=== -..spec.triggeredBy[].githubWebHook.revision +=== .spec.triggeredBy[].githubWebHook.revision Description:: + -- @@ -1652,7 +1654,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.triggeredBy[].githubWebHook.revision.git +=== .spec.triggeredBy[].githubWebHook.revision.git Description:: + -- @@ -1686,7 +1688,7 @@ Type:: | message is the description of a specific commit |=== -..spec.triggeredBy[].githubWebHook.revision.git.author +=== .spec.triggeredBy[].githubWebHook.revision.git.author Description:: + -- @@ -1712,7 +1714,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].githubWebHook.revision.git.committer +=== .spec.triggeredBy[].githubWebHook.revision.git.committer Description:: + -- @@ -1738,7 +1740,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].gitlabWebHook +=== .spec.triggeredBy[].gitlabWebHook Description:: + -- @@ -1764,7 +1766,7 @@ Type:: | Secret is the obfuscated webhook secret that triggered a build. |=== -..spec.triggeredBy[].gitlabWebHook.revision +=== .spec.triggeredBy[].gitlabWebHook.revision Description:: + -- @@ -1792,7 +1794,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.triggeredBy[].gitlabWebHook.revision.git +=== .spec.triggeredBy[].gitlabWebHook.revision.git Description:: + -- @@ -1826,7 +1828,7 @@ Type:: | message is the description of a specific commit |=== -..spec.triggeredBy[].gitlabWebHook.revision.git.author +=== .spec.triggeredBy[].gitlabWebHook.revision.git.author Description:: + -- @@ -1852,7 +1854,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].gitlabWebHook.revision.git.committer +=== .spec.triggeredBy[].gitlabWebHook.revision.git.committer Description:: + -- @@ -1878,7 +1880,7 @@ Type:: | name of the source control user |=== -..spec.triggeredBy[].imageChangeBuild +=== .spec.triggeredBy[].imageChangeBuild Description:: + -- @@ -1896,7 +1898,7 @@ Type:: | Property | Type | Description | `fromRef` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | fromRef contains detailed information about an image that triggered a build. | `imageID` @@ -1904,7 +1906,7 @@ Type:: | imageID is the ID of the image that triggered a a new build. |=== -..status +=== .status Description:: + -- @@ -1928,7 +1930,7 @@ Required:: | cancelled describes if a cancel event was triggered for the build. | `completionTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | completionTimestamp is a timestamp representing the server time when this Build was finished, whether that build failed or succeeded. It reflects the time at which the Pod running the Build terminated. It is represented in RFC3339 form and is in UTC. | `conditions` @@ -1940,7 +1942,7 @@ Required:: | BuildCondition describes the state of a build at a certain point. | `config` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | config is an ObjectReference to the BuildConfig this Build is based on. | `duration` @@ -1980,11 +1982,11 @@ Required:: | StageInfo contains details about a build stage. | `startTimestamp` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | startTimestamp is a timestamp representing the server time when this Build started running in a Pod. It is represented in RFC3339 form and is in UTC. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -1997,7 +1999,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -2018,11 +2020,11 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time the condition transitioned from one status to another. | `lastUpdateTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time this condition was updated. | `message` @@ -2042,7 +2044,7 @@ Required:: | Type of build condition. |=== -..status.output +=== .status.output Description:: + -- @@ -2064,7 +2066,7 @@ Type:: | BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed. |=== -..status.output.to +=== .status.output.to Description:: + -- @@ -2088,7 +2090,7 @@ Type:: Please note that this field may not always be set even if the push completes successfully - e.g. when the registry returns no digest or returns it in a format that the builder doesn't understand. |=== -..status.stages +=== .status.stages Description:: + -- @@ -2101,7 +2103,7 @@ Type:: -..status.stages[] +=== .status.stages[] Description:: + -- @@ -2127,7 +2129,7 @@ Type:: | name is a unique identifier for each build stage that occurs. | `startTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | startTime is a timestamp representing the server time when this Stage started. It is represented in RFC3339 form and is in UTC. | `steps` @@ -2139,7 +2141,7 @@ Type:: | StepInfo contains details about a build step. |=== -..status.stages[].steps +=== .status.stages[].steps Description:: + -- @@ -2152,7 +2154,7 @@ Type:: -..status.stages[].steps[] +=== .status.stages[].steps[] Description:: + -- @@ -2178,7 +2180,7 @@ Type:: | name is a unique identifier for each build step. | `startTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | startTime is a timestamp representing the server time when this Step started. it is represented in RFC3339 form and is in UTC. |=== @@ -2189,21 +2191,27 @@ The following API endpoints are available: * `/apis/build.openshift.io/v1/builds` - `GET`: list or watch objects of kind Build +* `/apis/build.openshift.io/v1/watch/builds` +- `GET`: watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/build.openshift.io/v1/namespaces/{namespace}/builds` - `DELETE`: delete collection of Build - `GET`: list or watch objects of kind Build - `POST`: create a Build +* `/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds` +- `GET`: watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}` - `DELETE`: delete a Build - `GET`: read the specified Build - `PATCH`: partially update the specified Build - `PUT`: replace the specified Build -* `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/log` -- `GET`: read log of the specified Build -* `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone` -- `POST`: create clone of a Build +* `/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds/{name}` +- `GET`: watch changes to an object of kind Build. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/details` - `PUT`: replace details of the specified Build +* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks` +- `POST`: connect POST requests to webhooks of BuildConfig +* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}` +- `POST`: connect POST requests to webhooks of BuildConfig === /apis/build.openshift.io/v1/builds @@ -2265,7 +2273,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildlist-build-openshift-io-v1[`BuildList build.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.build.v1.BuildList[`BuildList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/build.openshift.io/v1/watch/builds + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -2348,7 +2423,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -2357,7 +2432,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2414,7 +2491,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildlist-build-openshift-io-v1[`BuildList build.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.build.v1.BuildList[`BuildList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2441,7 +2520,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema | |=== @@ -2450,7 +2529,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 202 - Accepted +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -2507,7 +2665,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -2516,7 +2674,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2531,7 +2693,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2561,7 +2725,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2570,7 +2734,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2597,7 +2763,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema | |=== @@ -2606,11 +2772,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/log +=== /apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -2618,7 +2788,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the BuildLog +| name of the Build | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -2628,46 +2798,51 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `container` -| `string` -| cointainer for which to stream logs. Defaults to only container if there is one container in the pod. -| `follow` -| `boolean` -| follow if true indicates that the build log should be streamed until the build terminates. -| `insecureSkipTLSVerifyBackend` +| `allowWatchBookmarks` | `boolean` -| insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). -| `limitBytes` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` | `integer` -| limitBytes, If set, is the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. -| `nowait` -| `boolean` -| noWait if true causes the call to return immediately even if the build is not available yet. Otherwise the server will wait until the build has started. +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. -| `previous` -| `boolean` -| previous returns previous build logs. Defaults to false. -| `sinceSeconds` -| `integer` -| sinceSeconds is a relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. -| `tailLines` +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` | `integer` -| tailLines, If set, is the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime -| `timestamps` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` | `boolean` -| timestamps, If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. -| `version` -| `integer` -| version of the build for which to view logs. +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: - read log of the specified Build + watch changes to an object of kind Build. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. .HTTP responses @@ -2675,11 +2850,13 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildlog-build-openshift-io-v1[`BuildLog build.openshift.io/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone +=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/details .Global path parameters [cols="1,1,2",options="header"] @@ -2687,7 +2864,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the BuildRequest +| name of the Build | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -2709,10 +2886,10 @@ Description:: |=== HTTP method:: - `POST` + `PUT` Description:: - create clone of a Build + replace details of the specified Build @@ -2721,7 +2898,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#buildrequest-build-openshift-io-v1[`BuildRequest build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema | |=== @@ -2730,11 +2907,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildrequest-build-openshift-io-v1[`BuildRequest build.openshift.io/v1`] +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/details +=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks .Global path parameters [cols="1,1,2",options="header"] @@ -2752,40 +2933,70 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `dryRun` +| `path` | `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -| `pretty` -| `string` -| If 'true', then the output is pretty printed. +| Path is the URL path to use for the current proxy request to pod. |=== HTTP method:: - `PUT` + `POST` Description:: - replace details of the specified Build + connect POST requests to webhooks of BuildConfig + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `string` +| 401 - Unauthorized +| Empty +|=== +=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path} -.Body parameters +.Global path parameters [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `body` -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] -| +| `name` +| `string` +| name of the Build +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +| `path` +| `string` +| path to the resource |=== +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `path` +| `string` +| Path is the URL path to use for the current proxy request to pod. +|=== + +HTTP method:: + `POST` + +Description:: + connect POST requests to webhooks of BuildConfig + + .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| `string` +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc b/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc index 66b71aae55d9..bec46e1201c9 100644 --- a/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc +++ b/rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="buildconfig-build-openshift-io-v1"] = BuildConfig [build.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -49,7 +51,7 @@ Required:: | BuildConfigStatus contains current state of the build config object. |=== -..spec +=== .spec Description:: + -- @@ -151,7 +153,7 @@ There are five different ways to configure the hook. As an example, all forms be It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed. | `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceRequirements[`ResourceRequirements`] | resources computes resource requirements to execute the build. | `revision` @@ -187,7 +189,7 @@ It is invalid to provide both Script and Command simultaneously. If none of the | BuildTriggerPolicy describes a policy for a single trigger that results in a new Build. |=== -..spec.output +=== .spec.output Description:: + -- @@ -213,15 +215,15 @@ Type:: | ImageLabel represents a label applied to the resulting image. | `pushSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | to defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a container image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified. |=== -..spec.output.imageLabels +=== .spec.output.imageLabels Description:: + -- @@ -234,7 +236,7 @@ Type:: -..spec.output.imageLabels[] +=== .spec.output.imageLabels[] Description:: + -- @@ -262,7 +264,7 @@ Required:: | value defines the literal value of the label. |=== -..spec.postCommit +=== .spec.postCommit Description:: + -- @@ -348,7 +350,7 @@ Type:: | script is a shell script to be run with `/bin/sh -ic`. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with `rake test`. If you need control over the image entrypoint, or if the image does not have `/bin/sh`, use Command and/or Args. The `-i` flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make `ruby`, `bundle` and other binaries available in the PATH. |=== -..spec.revision +=== .spec.revision Description:: + -- @@ -376,7 +378,7 @@ Required:: | type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |=== -..spec.revision.git +=== .spec.revision.git Description:: + -- @@ -410,7 +412,7 @@ Type:: | message is the description of a specific commit |=== -..spec.revision.git.author +=== .spec.revision.git.author Description:: + -- @@ -436,7 +438,7 @@ Type:: | name of the source control user |=== -..spec.revision.git.committer +=== .spec.revision.git.committer Description:: + -- @@ -462,7 +464,7 @@ Type:: | name of the source control user |=== -..spec.source +=== .spec.source Description:: + -- @@ -520,7 +522,7 @@ Type:: | SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. | `sourceSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. | `type` @@ -528,7 +530,7 @@ Type:: | type of build input to accept |=== -..spec.source.binary +=== .spec.source.binary Description:: + -- @@ -550,7 +552,7 @@ Type:: | asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as `/webapp.war` for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'. |=== -..spec.source.configMaps +=== .spec.source.configMaps Description:: + -- @@ -563,7 +565,7 @@ Type:: -..spec.source.configMaps[] +=== .spec.source.configMaps[] Description:: + -- @@ -583,7 +585,7 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | configMap is a reference to an existing configmap that you want to use in your build. | `destinationDir` @@ -591,7 +593,7 @@ Required:: | destinationDir is the directory where the files from the configmap should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. |=== -..spec.source.git +=== .spec.source.git Description:: + -- @@ -631,7 +633,7 @@ Required:: | uri points to the source that will be built. The structure of the source will depend on the type of build to run |=== -..spec.source.images +=== .spec.source.images Description:: + -- @@ -644,7 +646,7 @@ Type:: -..spec.source.images[] +=== .spec.source.images[] Description:: + -- @@ -668,7 +670,7 @@ Required:: | A list of image names that this source will be used in place of during a multi-stage container image build. For instance, a Dockerfile that uses "COPY --from=nginx:latest" will first check for an image source that has "nginx:latest" in this field before attempting to pull directly. If the Dockerfile does not reference an image source it is ignored. This field and paths may both be set, in which case the contents will be used twice. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from. | `paths` @@ -680,11 +682,11 @@ Required:: | ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. |=== -..spec.source.images[].paths +=== .spec.source.images[].paths Description:: + -- @@ -697,7 +699,7 @@ Type:: -..spec.source.images[].paths[] +=== .spec.source.images[].paths[] Description:: + -- @@ -726,7 +728,7 @@ Required:: | sourcePath is the absolute path of the file or directory inside the image to copy to the build directory. If the source path ends in /. then the content of the directory will be copied, but the directory itself will not be created at the destination. |=== -..spec.source.secrets +=== .spec.source.secrets Description:: + -- @@ -739,7 +741,7 @@ Type:: -..spec.source.secrets[] +=== .spec.source.secrets[] Description:: + -- @@ -763,11 +765,11 @@ Required:: | destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. | `secret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | secret is a reference to an existing secret that you want to use in your build. |=== -..spec.strategy +=== .spec.strategy Description:: + -- @@ -805,7 +807,7 @@ Type:: | type is the kind of build strategy. |=== -..spec.strategy.customStrategy +=== .spec.strategy.customStrategy Description:: + -- @@ -829,7 +831,7 @@ Required:: | buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `exposeDockerSocket` @@ -841,11 +843,11 @@ Required:: | forcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `secrets` @@ -857,7 +859,7 @@ Required:: | SecretSpec specifies a secret to be included in a build pod and its corresponding mount point |=== -..spec.strategy.customStrategy.secrets +=== .spec.strategy.customStrategy.secrets Description:: + -- @@ -870,7 +872,7 @@ Type:: -..spec.strategy.customStrategy.secrets[] +=== .spec.strategy.customStrategy.secrets[] Description:: + -- @@ -895,11 +897,11 @@ Required:: | mountPath is the path at which to mount the secret | `secretSource` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | secretSource is a reference to the secret |=== -..spec.strategy.dockerStrategy +=== .spec.strategy.dockerStrategy Description:: + -- @@ -917,7 +919,7 @@ Type:: | Property | Type | Description | `buildArgs` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details. NOTE: Only the 'name' and 'value' fields are supported. Any settings on the 'valueFrom' field are ignored. | `dockerfilePath` @@ -925,7 +927,7 @@ Type:: | dockerfilePath is the path of the Dockerfile that will be used to build the container image, relative to the root of the context (contextDir). Defaults to `Dockerfile` if unset. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `forcePull` @@ -933,7 +935,7 @@ Type:: | forcePull describes if the builder should pull the images from registry prior to building. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file. | `imageOptimizationPolicy` @@ -945,7 +947,7 @@ Type:: | noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `volumes` @@ -957,7 +959,7 @@ Type:: | BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. |=== -..spec.strategy.dockerStrategy.volumes +=== .spec.strategy.dockerStrategy.volumes Description:: + -- @@ -970,7 +972,7 @@ Type:: -..spec.strategy.dockerStrategy.volumes[] +=== .spec.strategy.dockerStrategy.volumes[] Description:: + -- @@ -1008,7 +1010,7 @@ Required:: | BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |=== -..spec.strategy.dockerStrategy.volumes[].mounts +=== .spec.strategy.dockerStrategy.volumes[].mounts Description:: + -- @@ -1021,7 +1023,7 @@ Type:: -..spec.strategy.dockerStrategy.volumes[].mounts[] +=== .spec.strategy.dockerStrategy.volumes[].mounts[] Description:: + -- @@ -1045,7 +1047,7 @@ Required:: | destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |=== -..spec.strategy.dockerStrategy.volumes[].source +=== .spec.strategy.dockerStrategy.volumes[].source Description:: + -- @@ -1065,11 +1067,11 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#configmapvolumesource-core-v1[`ConfigMapVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapVolumeSource[`ConfigMapVolumeSource`] | configMap represents a ConfigMap that should populate this volume | `secret` -| xref:../objects/index.adoc#secretvolumesource-core-v1[`SecretVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretVolumeSource[`SecretVolumeSource`] | secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | `type` @@ -1077,7 +1079,7 @@ Required:: | type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |=== -..spec.strategy.jenkinsPipelineStrategy +=== .spec.strategy.jenkinsPipelineStrategy Description:: + -- @@ -1095,7 +1097,7 @@ Type:: | Property | Type | Description | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a build pipeline. | `jenkinsfile` @@ -1107,7 +1109,7 @@ Type:: | JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir. |=== -..spec.strategy.sourceStrategy +=== .spec.strategy.sourceStrategy Description:: + -- @@ -1127,7 +1129,7 @@ Required:: | Property | Type | Description | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | env contains additional environment variables you want to pass into a builder container. | `forcePull` @@ -1135,7 +1137,7 @@ Required:: | forcePull describes if the builder should pull the images from registry prior to building. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled | `incremental` @@ -1143,7 +1145,7 @@ Required:: | incremental flag forces the Source build to do incremental builds if true. | `pullSecret` -| xref:../objects/index.adoc#localobjectreference_v2-core-v1[`LocalObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.LocalObjectReference_v2[`LocalObjectReference_v2`] | pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries | `scripts` @@ -1159,7 +1161,7 @@ Required:: | BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. |=== -..spec.strategy.sourceStrategy.volumes +=== .spec.strategy.sourceStrategy.volumes Description:: + -- @@ -1172,7 +1174,7 @@ Type:: -..spec.strategy.sourceStrategy.volumes[] +=== .spec.strategy.sourceStrategy.volumes[] Description:: + -- @@ -1210,7 +1212,7 @@ Required:: | BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |=== -..spec.strategy.sourceStrategy.volumes[].mounts +=== .spec.strategy.sourceStrategy.volumes[].mounts Description:: + -- @@ -1223,7 +1225,7 @@ Type:: -..spec.strategy.sourceStrategy.volumes[].mounts[] +=== .spec.strategy.sourceStrategy.volumes[].mounts[] Description:: + -- @@ -1247,7 +1249,7 @@ Required:: | destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |=== -..spec.strategy.sourceStrategy.volumes[].source +=== .spec.strategy.sourceStrategy.volumes[].source Description:: + -- @@ -1267,11 +1269,11 @@ Required:: | Property | Type | Description | `configMap` -| xref:../objects/index.adoc#configmapvolumesource-core-v1[`ConfigMapVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ConfigMapVolumeSource[`ConfigMapVolumeSource`] | configMap represents a ConfigMap that should populate this volume | `secret` -| xref:../objects/index.adoc#secretvolumesource-core-v1[`SecretVolumeSource core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.SecretVolumeSource[`SecretVolumeSource`] | secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret | `type` @@ -1279,7 +1281,7 @@ Required:: | type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |=== -..spec.triggers +=== .spec.triggers Description:: + -- @@ -1292,7 +1294,7 @@ Type:: -..spec.triggers[] +=== .spec.triggers[] Description:: + -- @@ -1348,7 +1350,7 @@ Required:: - ConfigChange ConfigChangeBuildTriggerType will trigger a build on an initial build config creation WARNING: In the future the behavior will change to trigger a build on any config change |=== -..spec.triggers[].bitbucket +=== .spec.triggers[].bitbucket Description:: + -- @@ -1378,7 +1380,7 @@ Type:: | SecretLocalReference contains information that points to the local secret being used |=== -..spec.triggers[].bitbucket.secretReference +=== .spec.triggers[].bitbucket.secretReference Description:: + -- @@ -1402,7 +1404,7 @@ Required:: | Name is the name of the resource in the same namespace being referenced |=== -..spec.triggers[].generic +=== .spec.triggers[].generic Description:: + -- @@ -1432,7 +1434,7 @@ Type:: | SecretLocalReference contains information that points to the local secret being used |=== -..spec.triggers[].generic.secretReference +=== .spec.triggers[].generic.secretReference Description:: + -- @@ -1456,7 +1458,7 @@ Required:: | Name is the name of the resource in the same namespace being referenced |=== -..spec.triggers[].github +=== .spec.triggers[].github Description:: + -- @@ -1486,7 +1488,7 @@ Type:: | SecretLocalReference contains information that points to the local secret being used |=== -..spec.triggers[].github.secretReference +=== .spec.triggers[].github.secretReference Description:: + -- @@ -1510,7 +1512,7 @@ Required:: | Name is the name of the resource in the same namespace being referenced |=== -..spec.triggers[].gitlab +=== .spec.triggers[].gitlab Description:: + -- @@ -1540,7 +1542,7 @@ Type:: | SecretLocalReference contains information that points to the local secret being used |=== -..spec.triggers[].gitlab.secretReference +=== .spec.triggers[].gitlab.secretReference Description:: + -- @@ -1564,7 +1566,7 @@ Required:: | Name is the name of the resource in the same namespace being referenced |=== -..spec.triggers[].imageChange +=== .spec.triggers[].imageChange Description:: + -- @@ -1582,7 +1584,7 @@ Type:: | Property | Type | Description | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | from is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration. | `lastTriggeredImageID` @@ -1594,7 +1596,7 @@ Type:: | paused is true if this trigger is temporarily disabled. Optional. |=== -..status +=== .status Description:: + -- @@ -1626,7 +1628,7 @@ Required:: | lastVersion is used to inform about number of last triggered build. |=== -..status.imageChangeTriggers +=== .status.imageChangeTriggers Description:: + -- @@ -1639,7 +1641,7 @@ Type:: -..status.imageChangeTriggers[] +=== .status.imageChangeTriggers[] Description:: + -- @@ -1661,7 +1663,7 @@ Type:: | ImageStreamTagReference references the ImageStreamTag in an image change trigger by namespace and name. | `lastTriggerTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | lastTriggerTime is the last time this particular ImageStreamTag triggered a Build to start. This field is only updated when this trigger specifically started a Build. | `lastTriggeredImageID` @@ -1669,7 +1671,7 @@ Type:: | lastTriggeredImageID represents the sha/id of the ImageStreamTag when a Build for this BuildConfig was started. The lastTriggeredImageID is updated each time a Build for this BuildConfig is started, even if this ImageStreamTag is not the reason the Build is started. |=== -..status.imageChangeTriggers[].from +=== .status.imageChangeTriggers[].from Description:: + -- @@ -1702,23 +1704,21 @@ The following API endpoints are available: * `/apis/build.openshift.io/v1/buildconfigs` - `GET`: list or watch objects of kind BuildConfig +* `/apis/build.openshift.io/v1/watch/buildconfigs` +- `GET`: watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs` - `DELETE`: delete collection of BuildConfig - `GET`: list or watch objects of kind BuildConfig - `POST`: create a BuildConfig +* `/apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs` +- `GET`: watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}` - `DELETE`: delete a BuildConfig - `GET`: read the specified BuildConfig - `PATCH`: partially update the specified BuildConfig - `PUT`: replace the specified BuildConfig -* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks` -- `POST`: connect POST requests to webhooks of BuildConfig -* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate` -- `POST`: create instantiate of a BuildConfig -* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}` -- `POST`: connect POST requests to webhooks of BuildConfig -* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary` -- `POST`: connect POST requests to instantiatebinary of BuildConfig +* `/apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs/{name}` +- `GET`: watch changes to an object of kind BuildConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. === /apis/build.openshift.io/v1/buildconfigs @@ -1780,7 +1780,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildconfiglist-build-openshift-io-v1[`BuildConfigList build.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.build.v1.BuildConfigList[`BuildConfigList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/build.openshift.io/v1/watch/buildconfigs + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -1863,7 +1930,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -1872,7 +1939,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1929,7 +1998,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#buildconfiglist-build-openshift-io-v1[`BuildConfigList build.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.build.v1.BuildConfigList[`BuildConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1956,7 +2027,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema | |=== @@ -1965,7 +2036,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 201 - Created +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 202 - Accepted +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -2022,7 +2172,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -2031,7 +2181,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2046,7 +2200,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2076,7 +2232,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -2085,7 +2241,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -2112,7 +2270,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema | |=== @@ -2121,11 +2279,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig build.openshift.io/v1`] +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 201 - Created +| xref:../workloads_apis/buildconfig-build-openshift-io-v1.adoc#buildconfig-build-openshift-io-v1[`BuildConfig`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks +=== /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -2133,7 +2295,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the Build +| name of the BuildConfig | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -2143,170 +2305,51 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `path` -| `string` -| Path is the URL path to use for the current proxy request to pod. -|=== - -HTTP method:: - `POST` - -Description:: - connect POST requests to webhooks of BuildConfig - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` | `string` -|=== - - -=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` | `string` -| name of the BuildRequest -| `namespace` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` | `string` -| object name and auth scope, such as for teams and projects -|=== +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `POST` - -Description:: - create instantiate of a BuildConfig - - - -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#buildrequest-build-openshift-io-v1[`BuildRequest build.openshift.io/v1`] -| -|=== - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] -|=== - - -=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path} - -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` -| `string` -| name of the Build -| `namespace` -| `string` -| object name and auth scope, such as for teams and projects -| `path` -| `string` -| path to the resource -|=== - -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `path` -| `string` -| Path is the URL path to use for the current proxy request to pod. -|=== - -HTTP method:: - `POST` - -Description:: - connect POST requests to webhooks of BuildConfig - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK +| `resourceVersion` | `string` -|=== - - -=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` -| `string` -| name of the BinaryBuildRequestOptions -| `namespace` +Defaults to unset +| `resourceVersionMatch` | `string` -| object name and auth scope, such as for teams and projects -|=== +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `asFile` -| `string` -| asFile determines if the binary should be created as a file within the source rather than extracted as an archive -| `revision.authorEmail` -| `string` -| revision.authorEmail of the source control user -| `revision.authorName` -| `string` -| revision.authorName of the source control user -| `revision.commit` -| `string` -| revision.commit is the value identifying a specific commit -| `revision.committerEmail` -| `string` -| revision.committerEmail of the source control user -| `revision.committerName` -| `string` -| revision.committerName of the source control user -| `revision.message` -| `string` -| revision.message is the description of a specific commit +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: - `POST` + `GET` Description:: - connect POST requests to instantiatebinary of BuildConfig + watch changes to an object of kind BuildConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. .HTTP responses @@ -2314,7 +2357,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build build.openshift.io/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/buildlog-build-openshift-io-v1.adoc b/rest_api/workloads_apis/buildlog-build-openshift-io-v1.adoc new file mode 100644 index 000000000000..849f4b3d359a --- /dev/null +++ b/rest_api/workloads_apis/buildlog-build-openshift-io-v1.adoc @@ -0,0 +1,117 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="buildlog-build-openshift-io-v1"] += BuildLog [build.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +BuildLog is the (unused) resource associated with the build log redirector +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/log` +- `GET`: read log of the specified Build + + +=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/log + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the BuildLog +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `container` +| `string` +| cointainer for which to stream logs. Defaults to only container if there is one container in the pod. +| `follow` +| `boolean` +| follow if true indicates that the build log should be streamed until the build terminates. +| `insecureSkipTLSVerifyBackend` +| `boolean` +| insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +| `limitBytes` +| `integer` +| limitBytes, If set, is the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +| `nowait` +| `boolean` +| noWait if true causes the call to return immediately even if the build is not available yet. Otherwise the server will wait until the build has started. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `previous` +| `boolean` +| previous returns previous build logs. Defaults to false. +| `sinceSeconds` +| `integer` +| sinceSeconds is a relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +| `tailLines` +| `integer` +| tailLines, If set, is the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +| `timestamps` +| `boolean` +| timestamps, If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +| `version` +| `integer` +| version of the build for which to view logs. +|=== + +HTTP method:: + `GET` + +Description:: + read log of the specified Build + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/buildlog-build-openshift-io-v1.adoc#buildlog-build-openshift-io-v1[`BuildLog`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/buildrequest-build-openshift-io-v1.adoc b/rest_api/workloads_apis/buildrequest-build-openshift-io-v1.adoc new file mode 100644 index 000000000000..4ebba473f50e --- /dev/null +++ b/rest_api/workloads_apis/buildrequest-build-openshift-io-v1.adoc @@ -0,0 +1,1039 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="buildrequest-build-openshift-io-v1"] += BuildRequest [build.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +BuildRequest is the resource used to pass parameters to build generator +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `binary` +| `object` +| BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source. + +| `dockerStrategyOptions` +| `object` +| DockerStrategyOptions contains extra strategy options for container image builds + +| `env` +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] +| env contains additional environment variables you want to pass into a builder container. + +| `from` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] +| from is the reference to the ImageStreamTag that triggered the build. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `lastVersion` +| `integer` +| lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn't match, a build will not be generated. + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| + +| `revision` +| `object` +| SourceRevision is the revision or commit information from the source for the build + +| `sourceStrategyOptions` +| `object` +| SourceStrategyOptions contains extra strategy options for Source builds + +| `triggeredBy` +| `array` +| triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers. + +| `triggeredBy[]` +| `object` +| BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration. + +| `triggeredByImage` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] +| triggeredByImage is the Image that triggered this build. + +|=== +=== .binary +Description:: ++ +-- +BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `asFile` +| `string` +| asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as `/webapp.war` for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'. + +|=== +=== .dockerStrategyOptions +Description:: ++ +-- +DockerStrategyOptions contains extra strategy options for container image builds +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `buildArgs` +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] +| Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details + +| `noCache` +| `boolean` +| noCache overrides the docker-strategy noCache option in the build config + +|=== +=== .revision +Description:: ++ +-- +SourceRevision is the revision or commit information from the source for the build +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `git` +| `object` +| GitSourceRevision is the commit information from a git source for a build + +| `type` +| `string` +| type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' + +|=== +=== .revision.git +Description:: ++ +-- +GitSourceRevision is the commit information from a git source for a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `author` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `commit` +| `string` +| commit is the commit hash identifying a specific commit + +| `committer` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `message` +| `string` +| message is the description of a specific commit + +|=== +=== .revision.git.author +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .revision.git.committer +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .sourceStrategyOptions +Description:: ++ +-- +SourceStrategyOptions contains extra strategy options for Source builds +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `incremental` +| `boolean` +| incremental overrides the source-strategy incremental option in the build config + +|=== +=== .triggeredBy +Description:: ++ +-- +triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers. +-- + +Type:: + `array` + + + + +=== .triggeredBy[] +Description:: ++ +-- +BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `bitbucketWebHook` +| `object` +| BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build. + +| `genericWebHook` +| `object` +| GenericWebHookCause holds information about a generic WebHook that triggered a build. + +| `githubWebHook` +| `object` +| GitHubWebHookCause has information about a GitHub webhook that triggered a build. + +| `gitlabWebHook` +| `object` +| GitLabWebHookCause has information about a GitLab webhook that triggered a build. + +| `imageChangeBuild` +| `object` +| ImageChangeCause contains information about the image that triggered a build + +| `message` +| `string` +| message is used to store a human readable message for why the build was triggered. E.g.: "Manually triggered by user", "Configuration change",etc. + +|=== +=== .triggeredBy[].bitbucketWebHook +Description:: ++ +-- +BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `revision` +| `object` +| SourceRevision is the revision or commit information from the source for the build + +| `secret` +| `string` +| Secret is the obfuscated webhook secret that triggered a build. + +|=== +=== .triggeredBy[].bitbucketWebHook.revision +Description:: ++ +-- +SourceRevision is the revision or commit information from the source for the build +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `git` +| `object` +| GitSourceRevision is the commit information from a git source for a build + +| `type` +| `string` +| type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' + +|=== +=== .triggeredBy[].bitbucketWebHook.revision.git +Description:: ++ +-- +GitSourceRevision is the commit information from a git source for a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `author` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `commit` +| `string` +| commit is the commit hash identifying a specific commit + +| `committer` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `message` +| `string` +| message is the description of a specific commit + +|=== +=== .triggeredBy[].bitbucketWebHook.revision.git.author +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].bitbucketWebHook.revision.git.committer +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].genericWebHook +Description:: ++ +-- +GenericWebHookCause holds information about a generic WebHook that triggered a build. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `revision` +| `object` +| SourceRevision is the revision or commit information from the source for the build + +| `secret` +| `string` +| secret is the obfuscated webhook secret that triggered a build. + +|=== +=== .triggeredBy[].genericWebHook.revision +Description:: ++ +-- +SourceRevision is the revision or commit information from the source for the build +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `git` +| `object` +| GitSourceRevision is the commit information from a git source for a build + +| `type` +| `string` +| type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' + +|=== +=== .triggeredBy[].genericWebHook.revision.git +Description:: ++ +-- +GitSourceRevision is the commit information from a git source for a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `author` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `commit` +| `string` +| commit is the commit hash identifying a specific commit + +| `committer` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `message` +| `string` +| message is the description of a specific commit + +|=== +=== .triggeredBy[].genericWebHook.revision.git.author +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].genericWebHook.revision.git.committer +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].githubWebHook +Description:: ++ +-- +GitHubWebHookCause has information about a GitHub webhook that triggered a build. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `revision` +| `object` +| SourceRevision is the revision or commit information from the source for the build + +| `secret` +| `string` +| secret is the obfuscated webhook secret that triggered a build. + +|=== +=== .triggeredBy[].githubWebHook.revision +Description:: ++ +-- +SourceRevision is the revision or commit information from the source for the build +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `git` +| `object` +| GitSourceRevision is the commit information from a git source for a build + +| `type` +| `string` +| type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' + +|=== +=== .triggeredBy[].githubWebHook.revision.git +Description:: ++ +-- +GitSourceRevision is the commit information from a git source for a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `author` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `commit` +| `string` +| commit is the commit hash identifying a specific commit + +| `committer` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `message` +| `string` +| message is the description of a specific commit + +|=== +=== .triggeredBy[].githubWebHook.revision.git.author +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].githubWebHook.revision.git.committer +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].gitlabWebHook +Description:: ++ +-- +GitLabWebHookCause has information about a GitLab webhook that triggered a build. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `revision` +| `object` +| SourceRevision is the revision or commit information from the source for the build + +| `secret` +| `string` +| Secret is the obfuscated webhook secret that triggered a build. + +|=== +=== .triggeredBy[].gitlabWebHook.revision +Description:: ++ +-- +SourceRevision is the revision or commit information from the source for the build +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `git` +| `object` +| GitSourceRevision is the commit information from a git source for a build + +| `type` +| `string` +| type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' + +|=== +=== .triggeredBy[].gitlabWebHook.revision.git +Description:: ++ +-- +GitSourceRevision is the commit information from a git source for a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `author` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `commit` +| `string` +| commit is the commit hash identifying a specific commit + +| `committer` +| `object` +| SourceControlUser defines the identity of a user of source control + +| `message` +| `string` +| message is the description of a specific commit + +|=== +=== .triggeredBy[].gitlabWebHook.revision.git.author +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].gitlabWebHook.revision.git.committer +Description:: ++ +-- +SourceControlUser defines the identity of a user of source control +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `email` +| `string` +| email of the source control user + +| `name` +| `string` +| name of the source control user + +|=== +=== .triggeredBy[].imageChangeBuild +Description:: ++ +-- +ImageChangeCause contains information about the image that triggered a build +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fromRef` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] +| fromRef contains detailed information about an image that triggered a build. + +| `imageID` +| `string` +| imageID is the ID of the image that triggered a a new build. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone` +- `POST`: create clone of a Build +* `/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate` +- `POST`: create instantiate of a BuildConfig + + +=== /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the BuildRequest +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create clone of a Build + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[`BuildRequest`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[`BuildRequest`] schema +| 201 - Created +| xref:../workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[`BuildRequest`] schema +| 202 - Accepted +| xref:../workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[`BuildRequest`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the BuildRequest +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create instantiate of a BuildConfig + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/buildrequest-build-openshift-io-v1.adoc#buildrequest-build-openshift-io-v1[`BuildRequest`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 201 - Created +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 202 - Accepted +| xref:../workloads_apis/build-build-openshift-io-v1.adoc#build-build-openshift-io-v1[`Build`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/cronjob-batch-v1.adoc b/rest_api/workloads_apis/cronjob-batch-v1.adoc index 7386eb83f133..1a35437b8265 100644 --- a/rest_api/workloads_apis/cronjob-batch-v1.adoc +++ b/rest_api/workloads_apis/cronjob-batch-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="cronjob-batch-v1"] = CronJob [batch/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | CronJobStatus represents the current state of a cron job. |=== -..spec +=== .spec Description:: + -- @@ -94,7 +96,7 @@ Required:: | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |=== -..spec.jobTemplate +=== .spec.jobTemplate Description:: + -- @@ -112,7 +114,7 @@ Type:: | Property | Type | Description | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -120,7 +122,7 @@ Type:: | JobSpec describes how the job execution will look like. |=== -..spec.jobTemplate.spec +=== .spec.jobTemplate.spec Description:: + -- @@ -170,7 +172,7 @@ This field is beta-level. More completion modes can be added in the future. If t | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `suspend` @@ -180,7 +182,7 @@ This field is beta-level. More completion modes can be added in the future. If t This field is beta-level, gated by SuspendJob feature flag (enabled by default). | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `ttlSecondsAfterFinished` @@ -188,7 +190,7 @@ This field is beta-level, gated by SuspendJob feature flag (enabled by default). | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |=== -..status +=== .status Description:: + -- @@ -206,15 +208,15 @@ Type:: | Property | Type | Description | `active` -| xref:../objects/index.adoc#objectreference-core-v1[`array (ObjectReference core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference[`array (ObjectReference)`] | A list of pointers to currently running jobs. | `lastScheduleTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Information when was the last time the job was successfully scheduled. | `lastSuccessfulTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Information when was the last time the job successfully completed. |=== @@ -225,15 +227,21 @@ The following API endpoints are available: * `/apis/batch/v1/cronjobs` - `GET`: list or watch objects of kind CronJob +* `/apis/batch/v1/watch/cronjobs` +- `GET`: watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/cronjobs` - `DELETE`: delete collection of CronJob - `GET`: list or watch objects of kind CronJob - `POST`: create a CronJob +* `/apis/batch/v1/watch/namespaces/{namespace}/cronjobs` +- `GET`: watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}` - `DELETE`: delete a CronJob - `GET`: read the specified CronJob - `PATCH`: partially update the specified CronJob - `PUT`: replace the specified CronJob +* `/apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}` +- `GET`: watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status` - `GET`: read status of the specified CronJob - `PATCH`: partially update status of the specified CronJob @@ -299,7 +307,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#cronjoblist-batch-v1[`CronJobList batch/v1`] +| xref:../objects/index.adoc#io.k8s.api.batch.v1.CronJobList[`CronJobList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/cronjobs + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -382,7 +457,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -391,7 +466,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -448,7 +525,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#cronjoblist-batch-v1[`CronJobList batch/v1`] +| xref:../objects/index.adoc#io.k8s.api.batch.v1.CronJobList[`CronJobList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -475,7 +554,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema | |=== @@ -484,7 +563,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 201 - Created +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 202 - Accepted +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/namespaces/{namespace}/cronjobs + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -541,7 +699,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -550,7 +708,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -565,7 +727,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -595,7 +759,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -604,7 +768,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 201 - Created +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -631,7 +799,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema | |=== @@ -640,7 +808,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 201 - Created +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the CronJob +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -679,7 +927,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -709,7 +959,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -718,7 +968,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 201 - Created +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -745,7 +999,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema | |=== @@ -754,7 +1008,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob batch/v1`] +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 201 - Created +| xref:../workloads_apis/cronjob-batch-v1.adoc#cronjob-batch-v1[`CronJob`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/daemonset-apps-v1.adoc b/rest_api/workloads_apis/daemonset-apps-v1.adoc index cfa5bfd6b46f..d757ba99306e 100644 --- a/rest_api/workloads_apis/daemonset-apps-v1.adoc +++ b/rest_api/workloads_apis/daemonset-apps-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="daemonset-apps-v1"] = DaemonSet [apps/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | DaemonSetStatus represents the current status of a daemon set. |=== -..spec +=== .spec Description:: + -- @@ -74,11 +76,11 @@ Required:: | The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | `updateStrategy` @@ -86,7 +88,7 @@ Required:: | DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. |=== -..spec.updateStrategy +=== .spec.updateStrategy Description:: + -- @@ -112,7 +114,7 @@ Type:: | Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. |=== -..spec.updateStrategy.rollingUpdate +=== .spec.updateStrategy.rollingUpdate Description:: + -- @@ -130,15 +132,15 @@ Type:: | Property | Type | Description | `maxSurge` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is beta field and enabled/disabled by DaemonSetUpdateSurge feature gate. | `maxUnavailable` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |=== -..status +=== .status Description:: + -- @@ -205,7 +207,7 @@ Required:: | The total number of nodes that are running updated daemon pod |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -218,7 +220,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -239,7 +241,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transitioned from one status to another. | `message` @@ -266,15 +268,21 @@ The following API endpoints are available: * `/apis/apps/v1/daemonsets` - `GET`: list or watch objects of kind DaemonSet +* `/apis/apps/v1/watch/daemonsets` +- `GET`: watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/daemonsets` - `DELETE`: delete collection of DaemonSet - `GET`: list or watch objects of kind DaemonSet - `POST`: create a DaemonSet +* `/apis/apps/v1/watch/namespaces/{namespace}/daemonsets` +- `GET`: watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}` - `DELETE`: delete a DaemonSet - `GET`: read the specified DaemonSet - `PATCH`: partially update the specified DaemonSet - `PUT`: replace the specified DaemonSet +* `/apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}` +- `GET`: watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status` - `GET`: read status of the specified DaemonSet - `PATCH`: partially update status of the specified DaemonSet @@ -340,7 +348,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#daemonsetlist-apps-v1[`DaemonSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.DaemonSetList[`DaemonSetList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/daemonsets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -423,7 +498,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -432,7 +507,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -489,7 +566,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#daemonsetlist-apps-v1[`DaemonSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.DaemonSetList[`DaemonSetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -516,7 +595,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema | |=== @@ -525,7 +604,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 201 - Created +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 202 - Accepted +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/daemonsets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -582,7 +740,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -591,7 +749,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -606,7 +768,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -636,7 +800,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -645,7 +809,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 201 - Created +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -672,7 +840,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema | |=== @@ -681,7 +849,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 201 - Created +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the DaemonSet +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -720,7 +968,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -750,7 +1000,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -759,7 +1009,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 201 - Created +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -786,7 +1040,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema | |=== @@ -795,7 +1049,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet apps/v1`] +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 201 - Created +| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/deployment-apps-v1.adoc b/rest_api/workloads_apis/deployment-apps-v1.adoc index fb1373903c1b..508e5e500013 100644 --- a/rest_api/workloads_apis/deployment-apps-v1.adoc +++ b/rest_api/workloads_apis/deployment-apps-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="deployment-apps-v1"] = Deployment [apps/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | DeploymentStatus is the most recently observed status of the Deployment. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Required:: | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. | `strategy` @@ -94,11 +96,11 @@ Required:: | DeploymentStrategy describes how to replace existing pods with new ones. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Template describes the pods that will be created. |=== -..spec.strategy +=== .spec.strategy Description:: + -- @@ -124,7 +126,7 @@ Type:: | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |=== -..spec.strategy.rollingUpdate +=== .spec.strategy.rollingUpdate Description:: + -- @@ -142,15 +144,15 @@ Type:: | Property | Type | Description | `maxSurge` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. | `maxUnavailable` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |=== -..status +=== .status Description:: + -- @@ -204,7 +206,7 @@ Type:: | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -217,7 +219,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -238,11 +240,11 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transitioned from one status to another. | `lastUpdateTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time this condition was updated. | `message` @@ -269,19 +271,21 @@ The following API endpoints are available: * `/apis/apps/v1/deployments` - `GET`: list or watch objects of kind Deployment +* `/apis/apps/v1/watch/deployments` +- `GET`: watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/deployments` - `DELETE`: delete collection of Deployment - `GET`: list or watch objects of kind Deployment - `POST`: create a Deployment +* `/apis/apps/v1/watch/namespaces/{namespace}/deployments` +- `GET`: watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/deployments/{name}` - `DELETE`: delete a Deployment - `GET`: read the specified Deployment - `PATCH`: partially update the specified Deployment - `PUT`: replace the specified Deployment -* `/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale` -- `GET`: read scale of the specified Deployment -- `PATCH`: partially update scale of the specified Deployment -- `PUT`: replace scale of the specified Deployment +* `/apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}` +- `GET`: watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status` - `GET`: read status of the specified Deployment - `PATCH`: partially update status of the specified Deployment @@ -347,7 +351,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#deploymentlist-apps-v1[`DeploymentList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.DeploymentList[`DeploymentList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/deployments + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -430,7 +501,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -439,7 +510,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -496,7 +569,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#deploymentlist-apps-v1[`DeploymentList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.DeploymentList[`DeploymentList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -523,7 +598,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema | |=== @@ -532,7 +607,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 201 - Created +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 202 - Accepted +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/deployments + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -589,7 +743,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -598,7 +752,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -613,7 +771,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -643,7 +803,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -652,7 +812,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 201 - Created +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -679,7 +843,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema | |=== @@ -688,11 +852,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 201 - Created +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale +=== /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -700,7 +868,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the Scale +| name of the Deployment | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -710,99 +878,61 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `pretty` +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` | `string` -| If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `GET` - -Description:: - read scale of the specified Deployment - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -|=== - -HTTP method:: - `PATCH` - -Description:: - partially update scale of the specified Deployment +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` | `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` +| If 'true', then the output is pretty printed. +| `resourceVersion` | `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). -| `force` -| `boolean` -| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. -|=== +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| -|=== +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: - `PUT` + `GET` Description:: - replace scale of the specified Deployment - - -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -|=== + watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -| -|=== .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -841,7 +971,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -871,7 +1003,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -880,7 +1012,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 201 - Created +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -907,7 +1043,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema | |=== @@ -916,7 +1052,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment apps/v1`] +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 201 - Created +| xref:../workloads_apis/deployment-apps-v1.adoc#deployment-apps-v1[`Deployment`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc b/rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc index 15b9a031ad42..51e53fe12406 100644 --- a/rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc +++ b/rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="deploymentconfig-apps-openshift-io-v1"] = DeploymentConfig [apps.openshift.io/v1] ifdef::product-title[] @@ -37,7 +39,7 @@ Required:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | | `spec` @@ -49,7 +51,7 @@ Required:: | DeploymentConfigStatus represents the current deployment state. |=== -..spec +=== .spec Description:: + -- @@ -91,7 +93,7 @@ Type:: | DeploymentStrategy describes how to perform a deployment. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Template is the object that describes the pod that will be created if insufficient replicas are detected. | `test` @@ -107,7 +109,7 @@ Type:: | DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment. |=== -..spec.strategy +=== .spec.strategy Description:: + -- @@ -145,7 +147,7 @@ Type:: | RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy. | `resources` -| xref:../objects/index.adoc#resourcerequirements-core-v1[`ResourceRequirements core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ResourceRequirements[`ResourceRequirements`] | Resources contains resource requirements to execute the deployment and any hooks. | `rollingParams` @@ -157,7 +159,7 @@ Type:: | Type is the name of a deployment strategy. |=== -..spec.strategy.customParams +=== .spec.strategy.customParams Description:: + -- @@ -179,7 +181,7 @@ Type:: | Command is optional and overrides CMD in the container Image. | `environment` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Environment holds the environment which will be given to the container for Image. | `image` @@ -187,7 +189,7 @@ Type:: | Image specifies a container image which can carry out a deployment. |=== -..spec.strategy.recreateParams +=== .spec.strategy.recreateParams Description:: + -- @@ -221,7 +223,7 @@ Type:: | TimeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used. |=== -..spec.strategy.recreateParams.mid +=== .spec.strategy.recreateParams.mid Description:: + -- @@ -257,7 +259,7 @@ Required:: | TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. |=== -..spec.strategy.recreateParams.mid.execNewPod +=== .spec.strategy.recreateParams.mid.execNewPod Description:: + -- @@ -286,7 +288,7 @@ Required:: | ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Env is a set of environment variables to supply to the hook pod's container. | `volumes` @@ -294,7 +296,7 @@ Required:: | Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied. |=== -..spec.strategy.recreateParams.mid.tagImages +=== .spec.strategy.recreateParams.mid.tagImages Description:: + -- @@ -307,7 +309,7 @@ Type:: -..spec.strategy.recreateParams.mid.tagImages[] +=== .spec.strategy.recreateParams.mid.tagImages[] Description:: + -- @@ -332,11 +334,11 @@ Required:: | ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container. | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | To is the target ImageStreamTag to set the container's image onto. |=== -..spec.strategy.recreateParams.post +=== .spec.strategy.recreateParams.post Description:: + -- @@ -372,7 +374,7 @@ Required:: | TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. |=== -..spec.strategy.recreateParams.post.execNewPod +=== .spec.strategy.recreateParams.post.execNewPod Description:: + -- @@ -401,7 +403,7 @@ Required:: | ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Env is a set of environment variables to supply to the hook pod's container. | `volumes` @@ -409,7 +411,7 @@ Required:: | Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied. |=== -..spec.strategy.recreateParams.post.tagImages +=== .spec.strategy.recreateParams.post.tagImages Description:: + -- @@ -422,7 +424,7 @@ Type:: -..spec.strategy.recreateParams.post.tagImages[] +=== .spec.strategy.recreateParams.post.tagImages[] Description:: + -- @@ -447,11 +449,11 @@ Required:: | ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container. | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | To is the target ImageStreamTag to set the container's image onto. |=== -..spec.strategy.recreateParams.pre +=== .spec.strategy.recreateParams.pre Description:: + -- @@ -487,7 +489,7 @@ Required:: | TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. |=== -..spec.strategy.recreateParams.pre.execNewPod +=== .spec.strategy.recreateParams.pre.execNewPod Description:: + -- @@ -516,7 +518,7 @@ Required:: | ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Env is a set of environment variables to supply to the hook pod's container. | `volumes` @@ -524,7 +526,7 @@ Required:: | Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied. |=== -..spec.strategy.recreateParams.pre.tagImages +=== .spec.strategy.recreateParams.pre.tagImages Description:: + -- @@ -537,7 +539,7 @@ Type:: -..spec.strategy.recreateParams.pre.tagImages[] +=== .spec.strategy.recreateParams.pre.tagImages[] Description:: + -- @@ -562,11 +564,11 @@ Required:: | ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container. | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | To is the target ImageStreamTag to set the container's image onto. |=== -..spec.strategy.rollingParams +=== .spec.strategy.rollingParams Description:: + -- @@ -588,7 +590,7 @@ Type:: | IntervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used. | `maxSurge` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | MaxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxUnavailable is 0. By default, 25% is used. @@ -596,7 +598,7 @@ This cannot be 0 if MaxUnavailable is 0. By default, 25% is used. Example: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods. | `maxUnavailable` -| xref:../objects/index.adoc#intorstring-util-none[`IntOrString util/none`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] | MaxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding down. This cannot be 0 if MaxSurge is 0. By default, 25% is used. @@ -620,7 +622,7 @@ Example: when this is set to 30%, the old RC can be scaled down by 30% immediate | UpdatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used. |=== -..spec.strategy.rollingParams.post +=== .spec.strategy.rollingParams.post Description:: + -- @@ -656,7 +658,7 @@ Required:: | TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. |=== -..spec.strategy.rollingParams.post.execNewPod +=== .spec.strategy.rollingParams.post.execNewPod Description:: + -- @@ -685,7 +687,7 @@ Required:: | ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Env is a set of environment variables to supply to the hook pod's container. | `volumes` @@ -693,7 +695,7 @@ Required:: | Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied. |=== -..spec.strategy.rollingParams.post.tagImages +=== .spec.strategy.rollingParams.post.tagImages Description:: + -- @@ -706,7 +708,7 @@ Type:: -..spec.strategy.rollingParams.post.tagImages[] +=== .spec.strategy.rollingParams.post.tagImages[] Description:: + -- @@ -731,11 +733,11 @@ Required:: | ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container. | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | To is the target ImageStreamTag to set the container's image onto. |=== -..spec.strategy.rollingParams.pre +=== .spec.strategy.rollingParams.pre Description:: + -- @@ -771,7 +773,7 @@ Required:: | TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag. |=== -..spec.strategy.rollingParams.pre.execNewPod +=== .spec.strategy.rollingParams.pre.execNewPod Description:: + -- @@ -800,7 +802,7 @@ Required:: | ContainerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container. | `env` -| xref:../objects/index.adoc#envvar_v2-core-v1[`array (EnvVar_v2 core/v1)`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.EnvVar_v2[`array (EnvVar_v2)`] | Env is a set of environment variables to supply to the hook pod's container. | `volumes` @@ -808,7 +810,7 @@ Required:: | Volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied. |=== -..spec.strategy.rollingParams.pre.tagImages +=== .spec.strategy.rollingParams.pre.tagImages Description:: + -- @@ -821,7 +823,7 @@ Type:: -..spec.strategy.rollingParams.pre.tagImages[] +=== .spec.strategy.rollingParams.pre.tagImages[] Description:: + -- @@ -846,11 +848,11 @@ Required:: | ContainerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container. | `to` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | To is the target ImageStreamTag to set the container's image onto. |=== -..spec.triggers +=== .spec.triggers Description:: + -- @@ -863,7 +865,7 @@ Type:: -..spec.triggers[] +=== .spec.triggers[] Description:: + -- @@ -889,7 +891,7 @@ Type:: | Type of the trigger |=== -..spec.triggers[].imageChangeParams +=== .spec.triggers[].imageChangeParams Description:: + -- @@ -917,7 +919,7 @@ Required:: | ContainerNames is used to restrict tag updates to the specified set of container names in a pod. If multiple triggers point to the same containers, the resulting behavior is undefined. Future API versions will make this a validation error. If ContainerNames does not point to a valid container, the trigger will be ignored. Future API versions will make this a validation error. | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | From is a reference to an image stream tag to watch for changes. From.Name is the only required subfield - if From.Namespace is blank, the namespace of the current deployment trigger will be used. | `lastTriggeredImage` @@ -925,7 +927,7 @@ Required:: | LastTriggeredImage is the last image to be triggered. |=== -..status +=== .status Description:: + -- @@ -990,7 +992,7 @@ Required:: | UpdatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -1003,7 +1005,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -1024,11 +1026,11 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time the condition transitioned from one status to another. | `lastUpdateTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time this condition was updated. | `message` @@ -1048,7 +1050,7 @@ Required:: | Type of deployment condition. |=== -..status.details +=== .status.details Description:: + -- @@ -1080,7 +1082,7 @@ Required:: | Message is the user specified change message, if this deployment was triggered manually by the user |=== -..status.details.causes +=== .status.details.causes Description:: + -- @@ -1093,7 +1095,7 @@ Type:: -..status.details.causes[] +=== .status.details.causes[] Description:: + -- @@ -1121,7 +1123,7 @@ Required:: | Type of the trigger that resulted in the creation of a new deployment |=== -..status.details.causes[].imageTrigger +=== .status.details.causes[].imageTrigger Description:: + -- @@ -1141,7 +1143,7 @@ Required:: | Property | Type | Description | `from` -| xref:../objects/index.adoc#objectreference_v2-core-v1[`ObjectReference_v2 core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] | From is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage. |=== @@ -1152,29 +1154,25 @@ The following API endpoints are available: * `/apis/apps.openshift.io/v1/deploymentconfigs` - `GET`: list or watch objects of kind DeploymentConfig +* `/apis/apps.openshift.io/v1/watch/deploymentconfigs` +- `GET`: watch individual changes to a list of DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs` - `DELETE`: delete collection of DeploymentConfig - `GET`: list or watch objects of kind DeploymentConfig - `POST`: create a DeploymentConfig +* `/apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs` +- `GET`: watch individual changes to a list of DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}` - `DELETE`: delete a DeploymentConfig - `GET`: read the specified DeploymentConfig - `PATCH`: partially update the specified DeploymentConfig - `PUT`: replace the specified DeploymentConfig -* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log` -- `GET`: read log of the specified DeploymentConfig -* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale` -- `GET`: read scale of the specified DeploymentConfig -- `PATCH`: partially update scale of the specified DeploymentConfig -- `PUT`: replace scale of the specified DeploymentConfig +* `/apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}` +- `GET`: watch changes to an object of kind DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/status` - `GET`: read status of the specified DeploymentConfig - `PATCH`: partially update status of the specified DeploymentConfig - `PUT`: replace status of the specified DeploymentConfig -* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback` -- `POST`: create rollback of a DeploymentConfig -* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate` -- `POST`: create instantiate of a DeploymentConfig === /apis/apps.openshift.io/v1/deploymentconfigs @@ -1236,7 +1234,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#deploymentconfiglist-apps-openshift-io-v1[`DeploymentConfigList apps.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.apps.v1.DeploymentConfigList[`DeploymentConfigList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps.openshift.io/v1/watch/deploymentconfigs + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -1319,7 +1384,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -1328,7 +1393,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1385,7 +1452,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#deploymentconfiglist-apps-openshift-io-v1[`DeploymentConfigList apps.openshift.io/v1`] +| xref:../objects/index.adoc#com.github.openshift.api.apps.v1.DeploymentConfigList[`DeploymentConfigList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1412,7 +1481,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema | |=== @@ -1421,7 +1490,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 201 - Created +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 202 - Accepted +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -1478,7 +1626,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -1487,7 +1635,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1502,7 +1654,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1532,7 +1686,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1541,7 +1695,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1568,7 +1724,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema | |=== @@ -1577,11 +1733,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 201 - Created +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log +=== /apis/apps.openshift.io/v1/watch/namespaces/{namespace}/deploymentconfigs/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -1589,7 +1749,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the DeploymentLog +| name of the DeploymentConfig | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -1599,165 +1759,61 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `container` -| `string` -| The container for which to stream logs. Defaults to only container if there is one container in the pod. -| `follow` -| `boolean` -| Follow if true indicates that the build log should be streamed until the build terminates. -| `limitBytes` -| `integer` -| If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. -| `nowait` +| `allowWatchBookmarks` | `boolean` -| NoWait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started. -| `pretty` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +| `continue` | `string` -| If 'true', then the output is pretty printed. -| `previous` -| `boolean` -| Return previous deployment logs. Defaults to false. -| `sinceSeconds` -| `integer` -| A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. -| `tailLines` -| `integer` -| If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime -| `timestamps` -| `boolean` -| If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. -| `version` -| `integer` -| Version of the deployment for which to view logs. -|=== - -HTTP method:: - `GET` - -Description:: - read log of the specified DeploymentConfig - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#deploymentlog-apps-openshift-io-v1[`DeploymentLog apps.openshift.io/v1`] -|=== - - -=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/scale +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` | `string` -| name of the Scale -| `namespace` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` | `string` -| object name and auth scope, such as for teams and projects -|=== +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `GET` - -Description:: - read scale of the specified DeploymentConfig - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-extensions-v1beta1[`Scale extensions/v1beta1`] -|=== - -HTTP method:: - `PATCH` - -Description:: - partially update scale of the specified DeploymentConfig - - -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` +| `resourceVersion` | `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). -| `force` -| `boolean` -| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. -|=== +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| -|=== +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-extensions-v1beta1[`Scale extensions/v1beta1`] +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: - `PUT` + `GET` Description:: - replace scale of the specified DeploymentConfig + watch changes to an object of kind DeploymentConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -|=== - -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#scale-extensions-v1beta1[`Scale extensions/v1beta1`] -| -|=== - .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale-extensions-v1beta1[`Scale extensions/v1beta1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -1796,7 +1852,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1826,7 +1884,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -1835,7 +1893,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -1862,117 +1922,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] -| -|=== - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig apps.openshift.io/v1`] -|=== - - -=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback - -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` -| `string` -| name of the DeploymentConfigRollback -| `namespace` -| `string` -| object name and auth scope, such as for teams and projects -|=== - -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -| `pretty` -| `string` -| If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `POST` - -Description:: - create rollback of a DeploymentConfig - - - -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback apps.openshift.io/v1`] -| -|=== - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback apps.openshift.io/v1`] -|=== - - -=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate - -.Global path parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `name` -| `string` -| name of the DeploymentRequest -| `namespace` -| `string` -| object name and auth scope, such as for teams and projects -|=== - -.Global query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -| `pretty` -| `string` -| If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `POST` - -Description:: - create instantiate of a DeploymentConfig - - - -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema | |=== @@ -1981,7 +1931,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest apps.openshift.io/v1`] +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 201 - Created +| xref:../workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc#deploymentconfig-apps-openshift-io-v1[`DeploymentConfig`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc b/rest_api/workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc new file mode 100644 index 000000000000..39fe7d7f12a5 --- /dev/null +++ b/rest_api/workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc @@ -0,0 +1,170 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="deploymentconfigrollback-apps-openshift-io-v1"] += DeploymentConfigRollback [apps.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +DeploymentConfigRollback provides the input to rollback generation. +-- + +Type:: + `object` + +Required:: + - `name` + - `spec` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the deployment config that will be rolled back. + +| `spec` +| `object` +| DeploymentConfigRollbackSpec represents the options for rollback generation. + +| `updatedAnnotations` +| `object (string)` +| UpdatedAnnotations is a set of new annotations that will be added in the deployment config. + +|=== +=== .spec +Description:: ++ +-- +DeploymentConfigRollbackSpec represents the options for rollback generation. +-- + +Type:: + `object` + +Required:: + - `from` + - `includeTriggers` + - `includeTemplate` + - `includeReplicationMeta` + - `includeStrategy` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `from` +| xref:../objects/index.adoc#io.k8s.api.core.v1.ObjectReference_v2[`ObjectReference_v2`] +| From points to a ReplicationController which is a deployment. + +| `includeReplicationMeta` +| `boolean` +| IncludeReplicationMeta specifies whether to include the replica count and selector. + +| `includeStrategy` +| `boolean` +| IncludeStrategy specifies whether to include the deployment Strategy. + +| `includeTemplate` +| `boolean` +| IncludeTemplate specifies whether to include the PodTemplateSpec. + +| `includeTriggers` +| `boolean` +| IncludeTriggers specifies whether to include config Triggers. + +| `revision` +| `integer` +| Revision to rollback to. If set to 0, rollback to the last revision. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback` +- `POST`: create rollback of a DeploymentConfig + + +=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/rollback + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the DeploymentConfigRollback +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create rollback of a DeploymentConfig + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback`] schema +| 201 - Created +| xref:../workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback`] schema +| 202 - Accepted +| xref:../workloads_apis/deploymentconfigrollback-apps-openshift-io-v1.adoc#deploymentconfigrollback-apps-openshift-io-v1[`DeploymentConfigRollback`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/deploymentlog-apps-openshift-io-v1.adoc b/rest_api/workloads_apis/deploymentlog-apps-openshift-io-v1.adoc new file mode 100644 index 000000000000..aab29d479291 --- /dev/null +++ b/rest_api/workloads_apis/deploymentlog-apps-openshift-io-v1.adoc @@ -0,0 +1,114 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="deploymentlog-apps-openshift-io-v1"] += DeploymentLog [apps.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +DeploymentLog represents the logs for a deployment +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log` +- `GET`: read log of the specified DeploymentConfig + + +=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/log + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the DeploymentLog +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `container` +| `string` +| The container for which to stream logs. Defaults to only container if there is one container in the pod. +| `follow` +| `boolean` +| Follow if true indicates that the build log should be streamed until the build terminates. +| `limitBytes` +| `integer` +| If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +| `nowait` +| `boolean` +| NoWait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `previous` +| `boolean` +| Return previous deployment logs. Defaults to false. +| `sinceSeconds` +| `integer` +| A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +| `tailLines` +| `integer` +| If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +| `timestamps` +| `boolean` +| If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +| `version` +| `integer` +| Version of the deployment for which to view logs. +|=== + +HTTP method:: + `GET` + +Description:: + read log of the specified DeploymentConfig + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/deploymentlog-apps-openshift-io-v1.adoc#deploymentlog-apps-openshift-io-v1[`DeploymentLog`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc b/rest_api/workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc new file mode 100644 index 000000000000..d9c0661cc3e6 --- /dev/null +++ b/rest_api/workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc @@ -0,0 +1,127 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="deploymentrequest-apps-openshift-io-v1"] += DeploymentRequest [apps.openshift.io/v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +DeploymentRequest is a request to a deployment config for a new deployment. +-- + +Type:: + `object` + +Required:: + - `name` + - `latest` + - `force` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `excludeTriggers` +| `array (string)` +| ExcludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified. + +| `force` +| `boolean` +| Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error. + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `latest` +| `boolean` +| Latest will update the deployment config with the latest state from all triggers. + +| `name` +| `string` +| Name of the deployment config for requesting a new deployment. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate` +- `POST`: create instantiate of a DeploymentConfig + + +=== /apis/apps.openshift.io/v1/namespaces/{namespace}/deploymentconfigs/{name}/instantiate + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the DeploymentRequest +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `POST` + +Description:: + create instantiate of a DeploymentConfig + + + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest`] schema +| 201 - Created +| xref:../workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest`] schema +| 202 - Accepted +| xref:../workloads_apis/deploymentrequest-apps-openshift-io-v1.adoc#deploymentrequest-apps-openshift-io-v1[`DeploymentRequest`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/job-batch-v1.adoc b/rest_api/workloads_apis/job-batch-v1.adoc index b2e1664598dc..00ef0849e7d2 100644 --- a/rest_api/workloads_apis/job-batch-v1.adoc +++ b/rest_api/workloads_apis/job-batch-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="job-batch-v1"] = Job [batch/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | JobStatus represents the current state of a Job. |=== -..spec +=== .spec Description:: + -- @@ -95,7 +97,7 @@ This field is beta-level. More completion modes can be added in the future. If t | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `suspend` @@ -105,7 +107,7 @@ This field is beta-level. More completion modes can be added in the future. If t This field is beta-level, gated by SuspendJob feature flag (enabled by default). | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `ttlSecondsAfterFinished` @@ -113,7 +115,7 @@ This field is beta-level, gated by SuspendJob feature flag (enabled by default). | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |=== -..status +=== .status Description:: + -- @@ -139,7 +141,7 @@ Type:: | CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". | `completionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. | `conditions` @@ -155,7 +157,7 @@ Type:: | The number of pods which reached phase Failed. | `startTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. | `succeeded` @@ -167,7 +169,7 @@ Type:: | UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -180,7 +182,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -201,11 +203,11 @@ Required:: | Property | Type | Description | `lastProbeTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` @@ -225,7 +227,7 @@ Required:: | Type of job condition, Complete or Failed. |=== -..status.uncountedTerminatedPods +=== .status.uncountedTerminatedPods Description:: + -- @@ -258,15 +260,21 @@ The following API endpoints are available: * `/apis/batch/v1/jobs` - `GET`: list or watch objects of kind Job +* `/apis/batch/v1/watch/jobs` +- `GET`: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/jobs` - `DELETE`: delete collection of Job - `GET`: list or watch objects of kind Job - `POST`: create a Job +* `/apis/batch/v1/watch/namespaces/{namespace}/jobs` +- `GET`: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/jobs/{name}` - `DELETE`: delete a Job - `GET`: read the specified Job - `PATCH`: partially update the specified Job - `PUT`: replace the specified Job +* `/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}` +- `GET`: watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status` - `GET`: read status of the specified Job - `PATCH`: partially update status of the specified Job @@ -332,7 +340,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#joblist-batch-v1[`JobList batch/v1`] +| xref:../objects/index.adoc#io.k8s.api.batch.v1.JobList[`JobList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/jobs + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -415,7 +490,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -424,7 +499,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -481,7 +558,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#joblist-batch-v1[`JobList batch/v1`] +| xref:../objects/index.adoc#io.k8s.api.batch.v1.JobList[`JobList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -508,7 +587,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== @@ -517,7 +596,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 201 - Created +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 202 - Accepted +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/namespaces/{namespace}/jobs + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -574,7 +732,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -583,7 +741,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -598,7 +760,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -628,7 +792,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -637,7 +801,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 201 - Created +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -664,7 +832,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== @@ -673,7 +841,87 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 201 - Created +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Job +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -712,7 +960,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -742,7 +992,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -751,7 +1001,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 201 - Created +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -778,7 +1032,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== @@ -787,7 +1041,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job batch/v1`] +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 201 - Created +| xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/persistentvolume-v1.adoc b/rest_api/workloads_apis/persistentvolume-v1.adoc new file mode 100644 index 000000000000..b299b66593b6 --- /dev/null +++ b/rest_api/workloads_apis/persistentvolume-v1.adoc @@ -0,0 +1,2284 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="persistentvolume-v1"] += PersistentVolume [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| PersistentVolumeSpec is the specification of a persistent volume. + +| `status` +| `object` +| PersistentVolumeStatus is the current status of a persistent volume. + +|=== +=== .spec +Description:: ++ +-- +PersistentVolumeSpec is the specification of a persistent volume. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes + +| `awsElasticBlockStore` +| `object` +| Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + +| `azureDisk` +| `object` +| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +| `azureFile` +| `object` +| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +| `capacity` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity + +| `cephfs` +| `object` +| Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +| `cinder` +| `object` +| Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +| `claimRef` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +| `csi` +| `object` +| Represents storage that is managed by an external CSI volume driver (Beta feature) + +| `fc` +| `object` +| Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + +| `flexVolume` +| `object` +| FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. + +| `flocker` +| `object` +| Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + +| `gcePersistentDisk` +| `object` +| Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + +| `glusterfs` +| `object` +| Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + +| `hostPath` +| `object` +| Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + +| `iscsi` +| `object` +| ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +| `local` +| `object` +| Local represents directly-attached storage with node affinity (Beta feature) + +| `mountOptions` +| `array (string)` +| A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options + +| `nfs` +| `object` +| Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + +| `nodeAffinity` +| `object` +| VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. + +| `persistentVolumeReclaimPolicy` +| `string` +| What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming + +| `photonPersistentDisk` +| `object` +| Represents a Photon Controller persistent disk resource. + +| `portworxVolume` +| `object` +| PortworxVolumeSource represents a Portworx volume resource. + +| `quobyte` +| `object` +| Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + +| `rbd` +| `object` +| Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + +| `scaleIO` +| `object` +| ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume + +| `storageClassName` +| `string` +| Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. + +| `storageos` +| `object` +| Represents a StorageOS persistent volume resource. + +| `volumeMode` +| `string` +| volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. + +| `vsphereVolume` +| `object` +| Represents a vSphere volume resource. + +|=== +=== .spec.awsElasticBlockStore +Description:: ++ +-- +Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + +| `readOnly` +| `boolean` +| Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `volumeID` +| `string` +| Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +|=== +=== .spec.azureDisk +Description:: ++ +-- +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `diskName` + - `diskURI` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `cachingMode` +| `string` +| Host Caching mode: None, Read Only, Read Write. + +| `diskName` +| `string` +| The Name of the data disk in the blob storage + +| `diskURI` +| `string` +| The URI the data disk in the blob storage + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `kind` +| `string` +| Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +|=== +=== .spec.azureFile +Description:: ++ +-- +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `secretName` + - `shareName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretName` +| `string` +| the name of secret that contains Azure Storage Account Name and Key + +| `secretNamespace` +| `string` +| the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod + +| `shareName` +| `string` +| Share Name + +|=== +=== .spec.cephfs +Description:: ++ +-- +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `monitors` +| `array (string)` +| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `path` +| `string` +| Optional: Used as the mounted root, rather than the full Ceph tree, default is / + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretFile` +| `string` +| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `user` +| `string` +| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +|=== +=== .spec.cephfs.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.cinder +Description:: ++ +-- +Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `volumeID` +| `string` +| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +|=== +=== .spec.cinder.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.claimRef +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .spec.csi +Description:: ++ +-- +Represents storage that is managed by an external CSI volume driver (Beta feature) +-- + +Type:: + `object` + +Required:: + - `driver` + - `volumeHandle` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `controllerExpandSecretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `controllerPublishSecretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `driver` +| `string` +| Driver is the name of the driver to use for this volume. Required. + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". + +| `nodePublishSecretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `nodeStageSecretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `readOnly` +| `boolean` +| Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). + +| `volumeAttributes` +| `object (string)` +| Attributes of the volume to publish. + +| `volumeHandle` +| `string` +| VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. + +|=== +=== .spec.csi.controllerExpandSecretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.csi.controllerPublishSecretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.csi.nodePublishSecretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.csi.nodeStageSecretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.fc +Description:: ++ +-- +Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `lun` +| `integer` +| Optional: FC target lun number + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `targetWWNs` +| `array (string)` +| Optional: FC target worldwide names (WWNs) + +| `wwids` +| `array (string)` +| Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + +|=== +=== .spec.flexVolume +Description:: ++ +-- +FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the driver to use for this volume. + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +| `options` +| `object (string)` +| Optional: Extra command options if any. + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +|=== +=== .spec.flexVolume.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.flocker +Description:: ++ +-- +Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `datasetName` +| `string` +| Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + +| `datasetUUID` +| `string` +| UUID of the dataset. This is unique identifier of a Flocker dataset + +|=== +=== .spec.gcePersistentDisk +Description:: ++ +-- +Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `pdName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `pdName` +| `string` +| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +|=== +=== .spec.glusterfs +Description:: ++ +-- +Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `endpoints` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `endpoints` +| `string` +| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `endpointsNamespace` +| `string` +| EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `path` +| `string` +| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `readOnly` +| `boolean` +| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +|=== +=== .spec.hostPath +Description:: ++ +-- +Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +| `type` +| `string` +| Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +|=== +=== .spec.iscsi +Description:: ++ +-- +ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `targetPortal` + - `iqn` + - `lun` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `chapAuthDiscovery` +| `boolean` +| whether support iSCSI Discovery CHAP authentication + +| `chapAuthSession` +| `boolean` +| whether support iSCSI Session CHAP authentication + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +| `initiatorName` +| `string` +| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +| `iqn` +| `string` +| Target iSCSI Qualified Name. + +| `iscsiInterface` +| `string` +| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + +| `lun` +| `integer` +| iSCSI Target Lun number. + +| `portals` +| `array (string)` +| iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `targetPortal` +| `string` +| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +|=== +=== .spec.iscsi.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.local +Description:: ++ +-- +Local represents directly-attached storage with node affinity (Beta feature) +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. + +| `path` +| `string` +| The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). + +|=== +=== .spec.nfs +Description:: ++ +-- +Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `server` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `readOnly` +| `boolean` +| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `server` +| `string` +| Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +|=== +=== .spec.nodeAffinity +Description:: ++ +-- +VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `required` +| `object` +| A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + +|=== +=== .spec.nodeAffinity.required +Description:: ++ +-- +A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +-- + +Type:: + `object` + +Required:: + - `nodeSelectorTerms` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeSelectorTerms` +| `array` +| Required. A list of node selector terms. The terms are ORed. + +| `nodeSelectorTerms[]` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +|=== +=== .spec.nodeAffinity.required.nodeSelectorTerms +Description:: ++ +-- +Required. A list of node selector terms. The terms are ORed. +-- + +Type:: + `array` + + + + +=== .spec.nodeAffinity.required.nodeSelectorTerms[] +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.photonPersistentDisk +Description:: ++ +-- +Represents a Photon Controller persistent disk resource. +-- + +Type:: + `object` + +Required:: + - `pdID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `pdID` +| `string` +| ID that identifies Photon Controller persistent disk + +|=== +=== .spec.portworxVolume +Description:: ++ +-- +PortworxVolumeSource represents a Portworx volume resource. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `volumeID` +| `string` +| VolumeID uniquely identifies a Portworx volume + +|=== +=== .spec.quobyte +Description:: ++ +-- +Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `registry` + - `volume` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `group` +| `string` +| Group to map volume access to Default is no group + +| `readOnly` +| `boolean` +| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + +| `registry` +| `string` +| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + +| `tenant` +| `string` +| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + +| `user` +| `string` +| User to map volume access to Defaults to serivceaccount user + +| `volume` +| `string` +| Volume is a string that references an already created Quobyte volume by name. + +|=== +=== .spec.rbd +Description:: ++ +-- +Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + - `image` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +| `image` +| `string` +| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `keyring` +| `string` +| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `monitors` +| `array (string)` +| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `pool` +| `string` +| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `user` +| `string` +| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +|=== +=== .spec.rbd.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.scaleIO +Description:: ++ +-- +ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume +-- + +Type:: + `object` + +Required:: + - `gateway` + - `system` + - `secretRef` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" + +| `gateway` +| `string` +| The host address of the ScaleIO API Gateway. + +| `protectionDomain` +| `string` +| The name of the ScaleIO Protection Domain for the configured storage. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + +| `sslEnabled` +| `boolean` +| Flag to enable/disable SSL communication with Gateway, default false + +| `storageMode` +| `string` +| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + +| `storagePool` +| `string` +| The ScaleIO Storage Pool associated with the protection domain. + +| `system` +| `string` +| The name of the storage system as configured in ScaleIO. + +| `volumeName` +| `string` +| The name of a volume already created in the ScaleIO system that is associated with this volume source. + +|=== +=== .spec.scaleIO.secretRef +Description:: ++ +-- +SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name is unique within a namespace to reference a secret resource. + +| `namespace` +| `string` +| Namespace defines the space within which the secret name must be unique. + +|=== +=== .spec.storageos +Description:: ++ +-- +Represents a StorageOS persistent volume resource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| ObjectReference contains enough information to let you inspect or modify the referred object. + +| `volumeName` +| `string` +| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + +| `volumeNamespace` +| `string` +| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +|=== +=== .spec.storageos.secretRef +Description:: ++ +-- +ObjectReference contains enough information to let you inspect or modify the referred object. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| API version of the referent. + +| `fieldPath` +| `string` +| If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +| `kind` +| `string` +| Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `namespace` +| `string` +| Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +| `resourceVersion` +| `string` +| Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +| `uid` +| `string` +| UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +|=== +=== .spec.vsphereVolume +Description:: ++ +-- +Represents a vSphere volume resource. +-- + +Type:: + `object` + +Required:: + - `volumePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `storagePolicyID` +| `string` +| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + +| `storagePolicyName` +| `string` +| Storage Policy Based Management (SPBM) profile name. + +| `volumePath` +| `string` +| Path that identifies vSphere volume vmdk + +|=== +=== .status +Description:: ++ +-- +PersistentVolumeStatus is the current status of a persistent volume. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| A human-readable message indicating details about why the volume is in this state. + +| `phase` +| `string` +| Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase + +| `reason` +| `string` +| Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/persistentvolumes` +- `DELETE`: delete collection of PersistentVolume +- `GET`: list or watch objects of kind PersistentVolume +- `POST`: create a PersistentVolume +* `/api/v1/watch/persistentvolumes` +- `GET`: watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/persistentvolumes/{name}` +- `DELETE`: delete a PersistentVolume +- `GET`: read the specified PersistentVolume +- `PATCH`: partially update the specified PersistentVolume +- `PUT`: replace the specified PersistentVolume +* `/api/v1/watch/persistentvolumes/{name}` +- `GET`: watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/persistentvolumes/{name}/status` +- `GET`: read status of the specified PersistentVolume +- `PATCH`: partially update status of the specified PersistentVolume +- `PUT`: replace status of the specified PersistentVolume + + +=== /api/v1/persistentvolumes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PersistentVolumeList[`PersistentVolumeList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 201 - Created +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 202 - Accepted +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/persistentvolumes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/persistentvolumes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolume +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 202 - Accepted +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified PersistentVolume + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 201 - Created +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 201 - Created +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/persistentvolumes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolume +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/persistentvolumes/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the PersistentVolume +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified PersistentVolume + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 201 - Created +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified PersistentVolume + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 201 - Created +| xref:../workloads_apis/persistentvolume-v1.adoc#persistentvolume-v1[`PersistentVolume`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/pod-v1.adoc b/rest_api/workloads_apis/pod-v1.adoc new file mode 100644 index 000000000000..27ddfe77ae30 --- /dev/null +++ b/rest_api/workloads_apis/pod-v1.adoc @@ -0,0 +1,10882 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="pod-v1"] += Pod [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| PodSpec is a description of a pod. + +| `status` +| `object` +| PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane. + +|=== +=== .spec +Description:: ++ +-- +PodSpec is a description of a pod. +-- + +Type:: + `object` + +Required:: + - `containers` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `activeDeadlineSeconds` +| `integer` +| Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. + +| `affinity` +| `object` +| Affinity is a group of affinity scheduling rules. + +| `automountServiceAccountToken` +| `boolean` +| AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + +| `containers` +| `array` +| List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + +| `containers[]` +| `object` +| A single application container that you want to run within a pod. + +| `dnsConfig` +| `object` +| PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + +| `dnsPolicy` +| `string` +| Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + +| `enableServiceLinks` +| `boolean` +| EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. + +| `ephemeralContainers` +| `array` +| List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + +| `ephemeralContainers[]` +| `object` +| An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + +| `hostAliases` +| `array` +| HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. + +| `hostAliases[]` +| `object` +| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + +| `hostIPC` +| `boolean` +| Use the host's ipc namespace. Optional: Default to false. + +| `hostNetwork` +| `boolean` +| Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + +| `hostPID` +| `boolean` +| Use the host's pid namespace. Optional: Default to false. + +| `hostname` +| `string` +| Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + +| `imagePullSecrets` +| `array` +| ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + +| `imagePullSecrets[]` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `initContainers` +| `array` +| List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + +| `initContainers[]` +| `object` +| A single application container that you want to run within a pod. + +| `nodeName` +| `string` +| NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + +| `nodeSelector` +| `object (string)` +| NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + +| `overhead` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature. + +| `preemptionPolicy` +| `string` +| PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +| `priority` +| `integer` +| The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + +| `priorityClassName` +| `string` +| If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + +| `readinessGates` +| `array` +| If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + +| `readinessGates[]` +| `object` +| PodReadinessGate contains the reference to a pod condition + +| `restartPolicy` +| `string` +| Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + +| `runtimeClassName` +| `string` +| RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14. + +| `schedulerName` +| `string` +| If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. + +| `securityContext` +| `object` +| PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + +| `serviceAccount` +| `string` +| DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. + +| `serviceAccountName` +| `string` +| ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + +| `setHostnameAsFQDN` +| `boolean` +| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. + +| `shareProcessNamespace` +| `boolean` +| Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + +| `subdomain` +| `string` +| If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + +| `tolerations` +| `array` +| If specified, the pod's tolerations. + +| `tolerations[]` +| `object` +| The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + +| `topologySpreadConstraints` +| `array` +| TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. + +| `topologySpreadConstraints[]` +| `object` +| TopologySpreadConstraint specifies how to spread matching pods among the given topology. + +| `volumes` +| `array` +| List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes + +| `volumes[]` +| `object` +| Volume represents a named volume in a pod that may be accessed by any container in the pod. + +|=== +=== .spec.affinity +Description:: ++ +-- +Affinity is a group of affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeAffinity` +| `object` +| Node affinity is a group of node affinity scheduling rules. + +| `podAffinity` +| `object` +| Pod affinity is a group of inter pod affinity scheduling rules. + +| `podAntiAffinity` +| `object` +| Pod anti affinity is a group of inter pod anti affinity scheduling rules. + +|=== +=== .spec.affinity.nodeAffinity +Description:: ++ +-- +Node affinity is a group of node affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `object` +| A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + +|=== +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). +-- + +Type:: + `object` + +Required:: + - `weight` + - `preference` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preference` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +| `weight` +| `integer` +| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + +|=== +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +-- + +Type:: + `object` + +Required:: + - `nodeSelectorTerms` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeSelectorTerms` +| `array` +| Required. A list of node selector terms. The terms are ORed. + +| `nodeSelectorTerms[]` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +|=== +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +Description:: ++ +-- +Required. A list of node selector terms. The terms are ORed. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.affinity.podAffinity +Description:: ++ +-- +Pod affinity is a group of inter pod affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.affinity.podAntiAffinity +Description:: ++ +-- +Pod anti affinity is a group of inter pod anti affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.containers +Description:: ++ +-- +List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.containers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.containers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.containers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.containers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.containers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.containers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.containers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.containers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.containers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.containers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.containers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.containers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.containers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.containers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.containers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.containers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.containers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.containers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.containers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.containers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.containers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.containers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.containers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.containers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.containers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.containers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.containers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.containers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.containers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.containers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.containers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.containers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.containers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.containers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.containers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.containers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.containers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.containers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.containers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.containers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.containers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.containers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.containers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.containers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.containers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.containers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.containers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.containers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.containers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.containers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.containers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.dnsConfig +Description:: ++ +-- +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nameservers` +| `array (string)` +| A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + +| `options` +| `array` +| A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + +| `options[]` +| `object` +| PodDNSConfigOption defines DNS resolver options of a pod. + +| `searches` +| `array (string)` +| A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + +|=== +=== .spec.dnsConfig.options +Description:: ++ +-- +A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. +-- + +Type:: + `array` + + + + +=== .spec.dnsConfig.options[] +Description:: ++ +-- +PodDNSConfigOption defines DNS resolver options of a pod. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Required. + +| `value` +| `string` +| + +|=== +=== .spec.ephemeralContainers +Description:: ++ +-- +List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[] +Description:: ++ +-- +An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. + +| `ports` +| `array` +| Ports are not allowed for ephemeral containers. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `targetContainerName` +| `string` +| If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.ephemeralContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.ephemeralContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.ephemeralContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.ephemeralContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.ephemeralContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.ephemeralContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.ephemeralContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.ephemeralContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.ephemeralContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.ephemeralContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.ephemeralContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.ephemeralContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.ephemeralContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.ephemeralContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.ephemeralContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.ephemeralContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.ephemeralContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.ephemeralContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.ephemeralContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.ephemeralContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.ephemeralContainers[].ports +Description:: ++ +-- +Ports are not allowed for ephemeral containers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.ephemeralContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.ephemeralContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.ephemeralContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.ephemeralContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.ephemeralContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.ephemeralContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.ephemeralContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.ephemeralContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.ephemeralContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.ephemeralContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.ephemeralContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.ephemeralContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.ephemeralContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.ephemeralContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.ephemeralContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.ephemeralContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.ephemeralContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.hostAliases +Description:: ++ +-- +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +-- + +Type:: + `array` + + + + +=== .spec.hostAliases[] +Description:: ++ +-- +HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostnames` +| `array (string)` +| Hostnames for the above IP address. + +| `ip` +| `string` +| IP address of the host file entry. + +|=== +=== .spec.imagePullSecrets +Description:: ++ +-- +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +-- + +Type:: + `array` + + + + +=== .spec.imagePullSecrets[] +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.initContainers +Description:: ++ +-- +List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ +-- + +Type:: + `array` + + + + +=== .spec.initContainers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.initContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.initContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.initContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.initContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.initContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.initContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.initContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.initContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.initContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.initContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.initContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.initContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.initContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.initContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.initContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.initContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.initContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.initContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.initContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.initContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.initContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.initContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.initContainers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.initContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.initContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.initContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.initContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.initContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.initContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.initContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.initContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.initContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.initContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.initContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.initContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.initContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.initContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.initContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.initContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.initContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.readinessGates +Description:: ++ +-- +If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates +-- + +Type:: + `array` + + + + +=== .spec.readinessGates[] +Description:: ++ +-- +PodReadinessGate contains the reference to a pod condition +-- + +Type:: + `object` + +Required:: + - `conditionType` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditionType` +| `string` +| ConditionType refers to a condition in the pod's condition list with matching type. + +|=== +=== .spec.securityContext +Description:: ++ +-- +PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsGroup` +| `integer` +| A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: + +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- + +If unset, the Kubelet will not modify the ownership and permissions of any volume. + +| `fsGroupChangePolicy` +| `string` +| fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `supplementalGroups` +| `array (integer)` +| A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. + +| `sysctls` +| `array` +| Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. + +| `sysctls[]` +| `object` +| Sysctl defines a kernel parameter to be set + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.securityContext.sysctls +Description:: ++ +-- +Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +-- + +Type:: + `array` + + + + +=== .spec.securityContext.sysctls[] +Description:: ++ +-- +Sysctl defines a kernel parameter to be set +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of a property to set + +| `value` +| `string` +| Value of a property to set + +|=== +=== .spec.securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.tolerations +Description:: ++ +-- +If specified, the pod's tolerations. +-- + +Type:: + `array` + + + + +=== .spec.tolerations[] +Description:: ++ +-- +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `effect` +| `string` +| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + +| `key` +| `string` +| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + +| `operator` +| `string` +| Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + +| `tolerationSeconds` +| `integer` +| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + +| `value` +| `string` +| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. + +|=== +=== .spec.topologySpreadConstraints +Description:: ++ +-- +TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. +-- + +Type:: + `array` + + + + +=== .spec.topologySpreadConstraints[] +Description:: ++ +-- +TopologySpreadConstraint specifies how to spread matching pods among the given topology. +-- + +Type:: + `object` + +Required:: + - `maxSkew` + - `topologyKey` + - `whenUnsatisfiable` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + +| `maxSkew` +| `integer` +| MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: \| zone1 \| zone2 \| zone3 \| \| P \| P \| \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. + +| `topologyKey` +| `string` +| TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + +| `whenUnsatisfiable` +| `string` +| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, + but giving higher precedence to topologies that would help reduce the + skew. +A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + +|=== +=== .spec.volumes +Description:: ++ +-- +List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +-- + +Type:: + `array` + + + + +=== .spec.volumes[] +Description:: ++ +-- +Volume represents a named volume in a pod that may be accessed by any container in the pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `awsElasticBlockStore` +| `object` +| Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + +| `azureDisk` +| `object` +| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +| `azureFile` +| `object` +| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +| `cephfs` +| `object` +| Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +| `cinder` +| `object` +| Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +| `configMap` +| `object` +| Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. + +| `csi` +| `object` +| Represents a source location of a volume to mount, managed by an external CSI driver + +| `downwardAPI` +| `object` +| DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. + +| `emptyDir` +| `object` +| Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. + +| `ephemeral` +| `object` +| Represents an ephemeral volume that is handled by a normal storage driver. + +| `fc` +| `object` +| Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + +| `flexVolume` +| `object` +| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +| `flocker` +| `object` +| Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + +| `gcePersistentDisk` +| `object` +| Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + +| `gitRepo` +| `object` +| Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + +| `glusterfs` +| `object` +| Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + +| `hostPath` +| `object` +| Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + +| `iscsi` +| `object` +| Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +| `name` +| `string` +| Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `nfs` +| `object` +| Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + +| `persistentVolumeClaim` +| `object` +| PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + +| `photonPersistentDisk` +| `object` +| Represents a Photon Controller persistent disk resource. + +| `portworxVolume` +| `object` +| PortworxVolumeSource represents a Portworx volume resource. + +| `projected` +| `object` +| Represents a projected volume source + +| `quobyte` +| `object` +| Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + +| `rbd` +| `object` +| Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + +| `scaleIO` +| `object` +| ScaleIOVolumeSource represents a persistent ScaleIO volume + +| `secret` +| `object` +| Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. + +| `storageos` +| `object` +| Represents a StorageOS persistent volume resource. + +| `vsphereVolume` +| `object` +| Represents a vSphere volume resource. + +|=== +=== .spec.volumes[].awsElasticBlockStore +Description:: ++ +-- +Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + +| `readOnly` +| `boolean` +| Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `volumeID` +| `string` +| Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +|=== +=== .spec.volumes[].azureDisk +Description:: ++ +-- +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `diskName` + - `diskURI` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `cachingMode` +| `string` +| Host Caching mode: None, Read Only, Read Write. + +| `diskName` +| `string` +| The Name of the data disk in the blob storage + +| `diskURI` +| `string` +| The URI the data disk in the blob storage + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `kind` +| `string` +| Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +|=== +=== .spec.volumes[].azureFile +Description:: ++ +-- +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `secretName` + - `shareName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretName` +| `string` +| the name of secret that contains Azure Storage Account Name and Key + +| `shareName` +| `string` +| Share Name + +|=== +=== .spec.volumes[].cephfs +Description:: ++ +-- +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `monitors` +| `array (string)` +| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `path` +| `string` +| Optional: Used as the mounted root, rather than the full Ceph tree, default is / + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretFile` +| `string` +| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +|=== +=== .spec.volumes[].cephfs.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].cinder +Description:: ++ +-- +Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeID` +| `string` +| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +|=== +=== .spec.volumes[].cinder.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .spec.volumes[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.volumes[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.volumes[].csi +Description:: ++ +-- +Represents a source location of a volume to mount, managed by an external CSI driver +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + +| `fsType` +| `string` +| Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + +| `nodePublishSecretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `readOnly` +| `boolean` +| Specifies a read-only configuration for the volume. Defaults to false (read/write). + +| `volumeAttributes` +| `object (string)` +| VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + +|=== +=== .spec.volumes[].csi.nodePublishSecretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].downwardAPI +Description:: ++ +-- +DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| Items is a list of downward API volume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .spec.volumes[].downwardAPI.items +Description:: ++ +-- +Items is a list of downward API volume file +-- + +Type:: + `array` + + + + +=== .spec.volumes[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .spec.volumes[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.volumes[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.volumes[].emptyDir +Description:: ++ +-- +Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `medium` +| `string` +| What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + +| `sizeLimit` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + +|=== +=== .spec.volumes[].ephemeral +Description:: ++ +-- +Represents an ephemeral volume that is handled by a normal storage driver. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `volumeClaimTemplate` +| `object` +| PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + +|=== +=== .spec.volumes[].ephemeral.volumeClaimTemplate +Description:: ++ +-- +PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. +-- + +Type:: + `object` + +Required:: + - `spec` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + +| `spec` +| `object` +| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + +|=== +=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec +Description:: ++ +-- +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +| `dataSource` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `dataSourceRef` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `selector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over volumes to consider for binding. + +| `storageClassName` +| `string` +| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + +| `volumeMode` +| `string` +| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + +| `volumeName` +| `string` +| VolumeName is the binding reference to the PersistentVolume backing this claim. + +|=== +=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.volumes[].fc +Description:: ++ +-- +Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `lun` +| `integer` +| Optional: FC target lun number + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `targetWWNs` +| `array (string)` +| Optional: FC target worldwide names (WWNs) + +| `wwids` +| `array (string)` +| Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + +|=== +=== .spec.volumes[].flexVolume +Description:: ++ +-- +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the driver to use for this volume. + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +| `options` +| `object (string)` +| Optional: Extra command options if any. + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +|=== +=== .spec.volumes[].flexVolume.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].flocker +Description:: ++ +-- +Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `datasetName` +| `string` +| Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + +| `datasetUUID` +| `string` +| UUID of the dataset. This is unique identifier of a Flocker dataset + +|=== +=== .spec.volumes[].gcePersistentDisk +Description:: ++ +-- +Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `pdName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `pdName` +| `string` +| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +|=== +=== .spec.volumes[].gitRepo +Description:: ++ +-- +Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. +-- + +Type:: + `object` + +Required:: + - `repository` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `directory` +| `string` +| Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + +| `repository` +| `string` +| Repository URL + +| `revision` +| `string` +| Commit hash for the specified revision. + +|=== +=== .spec.volumes[].glusterfs +Description:: ++ +-- +Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `endpoints` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `endpoints` +| `string` +| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `path` +| `string` +| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `readOnly` +| `boolean` +| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +|=== +=== .spec.volumes[].hostPath +Description:: ++ +-- +Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +| `type` +| `string` +| Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +|=== +=== .spec.volumes[].iscsi +Description:: ++ +-- +Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `targetPortal` + - `iqn` + - `lun` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `chapAuthDiscovery` +| `boolean` +| whether support iSCSI Discovery CHAP authentication + +| `chapAuthSession` +| `boolean` +| whether support iSCSI Session CHAP authentication + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +| `initiatorName` +| `string` +| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +| `iqn` +| `string` +| Target iSCSI Qualified Name. + +| `iscsiInterface` +| `string` +| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + +| `lun` +| `integer` +| iSCSI Target Lun number. + +| `portals` +| `array (string)` +| iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `targetPortal` +| `string` +| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +|=== +=== .spec.volumes[].iscsi.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].nfs +Description:: ++ +-- +Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `server` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `readOnly` +| `boolean` +| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `server` +| `string` +| Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +|=== +=== .spec.volumes[].persistentVolumeClaim +Description:: ++ +-- +PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). +-- + +Type:: + `object` + +Required:: + - `claimName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `claimName` +| `string` +| ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +| `readOnly` +| `boolean` +| Will force the ReadOnly setting in VolumeMounts. Default false. + +|=== +=== .spec.volumes[].photonPersistentDisk +Description:: ++ +-- +Represents a Photon Controller persistent disk resource. +-- + +Type:: + `object` + +Required:: + - `pdID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `pdID` +| `string` +| ID that identifies Photon Controller persistent disk + +|=== +=== .spec.volumes[].portworxVolume +Description:: ++ +-- +PortworxVolumeSource represents a Portworx volume resource. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `volumeID` +| `string` +| VolumeID uniquely identifies a Portworx volume + +|=== +=== .spec.volumes[].projected +Description:: ++ +-- +Represents a projected volume source +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `sources` +| `array` +| list of volume projections + +| `sources[]` +| `object` +| Projection that may be projected along with other supported volume types + +|=== +=== .spec.volumes[].projected.sources +Description:: ++ +-- +list of volume projections +-- + +Type:: + `array` + + + + +=== .spec.volumes[].projected.sources[] +Description:: ++ +-- +Projection that may be projected along with other supported volume types +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. + +| `downwardAPI` +| `object` +| Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. + +| `secret` +| `object` +| Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. + +| `serviceAccountToken` +| `object` +| ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + +|=== +=== .spec.volumes[].projected.sources[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .spec.volumes[].projected.sources[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.volumes[].projected.sources[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.volumes[].projected.sources[].downwardAPI +Description:: ++ +-- +Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| Items is a list of DownwardAPIVolume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .spec.volumes[].projected.sources[].downwardAPI.items +Description:: ++ +-- +Items is a list of DownwardAPIVolume file +-- + +Type:: + `array` + + + + +=== .spec.volumes[].projected.sources[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.volumes[].projected.sources[].secret +Description:: ++ +-- +Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.volumes[].projected.sources[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.volumes[].projected.sources[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.volumes[].projected.sources[].serviceAccountToken +Description:: ++ +-- +ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `audience` +| `string` +| Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + +| `expirationSeconds` +| `integer` +| ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + +| `path` +| `string` +| Path is the path relative to the mount point of the file to project the token into. + +|=== +=== .spec.volumes[].quobyte +Description:: ++ +-- +Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `registry` + - `volume` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `group` +| `string` +| Group to map volume access to Default is no group + +| `readOnly` +| `boolean` +| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + +| `registry` +| `string` +| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + +| `tenant` +| `string` +| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + +| `user` +| `string` +| User to map volume access to Defaults to serivceaccount user + +| `volume` +| `string` +| Volume is a string that references an already created Quobyte volume by name. + +|=== +=== .spec.volumes[].rbd +Description:: ++ +-- +Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + - `image` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +| `image` +| `string` +| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `keyring` +| `string` +| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `monitors` +| `array (string)` +| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `pool` +| `string` +| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +|=== +=== .spec.volumes[].rbd.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].scaleIO +Description:: ++ +-- +ScaleIOVolumeSource represents a persistent ScaleIO volume +-- + +Type:: + `object` + +Required:: + - `gateway` + - `system` + - `secretRef` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + +| `gateway` +| `string` +| The host address of the ScaleIO API Gateway. + +| `protectionDomain` +| `string` +| The name of the ScaleIO Protection Domain for the configured storage. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `sslEnabled` +| `boolean` +| Flag to enable/disable SSL communication with Gateway, default false + +| `storageMode` +| `string` +| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + +| `storagePool` +| `string` +| The ScaleIO Storage Pool associated with the protection domain. + +| `system` +| `string` +| The name of the storage system as configured in ScaleIO. + +| `volumeName` +| `string` +| The name of a volume already created in the ScaleIO system that is associated with this volume source. + +|=== +=== .spec.volumes[].scaleIO.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].secret +Description:: ++ +-- +Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `optional` +| `boolean` +| Specify whether the Secret or its keys must be defined + +| `secretName` +| `string` +| Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + +|=== +=== .spec.volumes[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.volumes[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.volumes[].storageos +Description:: ++ +-- +Represents a StorageOS persistent volume resource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeName` +| `string` +| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + +| `volumeNamespace` +| `string` +| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +|=== +=== .spec.volumes[].storageos.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.volumes[].vsphereVolume +Description:: ++ +-- +Represents a vSphere volume resource. +-- + +Type:: + `object` + +Required:: + - `volumePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `storagePolicyID` +| `string` +| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + +| `storagePolicyName` +| `string` +| Storage Policy Based Management (SPBM) profile name. + +| `volumePath` +| `string` +| Path that identifies vSphere volume vmdk + +|=== +=== .status +Description:: ++ +-- +PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditions` +| `array` +| Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions + +| `conditions[]` +| `object` +| PodCondition contains details for the current condition of this pod. + +| `containerStatuses` +| `array` +| The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status + +| `containerStatuses[]` +| `object` +| ContainerStatus contains details for the current status of this container. + +| `ephemeralContainerStatuses` +| `array` +| Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. + +| `ephemeralContainerStatuses[]` +| `object` +| ContainerStatus contains details for the current status of this container. + +| `hostIP` +| `string` +| IP address of the host to which the pod is assigned. Empty if not yet scheduled. + +| `initContainerStatuses` +| `array` +| The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status + +| `initContainerStatuses[]` +| `object` +| ContainerStatus contains details for the current status of this container. + +| `message` +| `string` +| A human readable message indicating details about why the pod is in this condition. + +| `nominatedNodeName` +| `string` +| nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. + +| `phase` +| `string` +| The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: + +Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. + +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase + +| `podIP` +| `string` +| IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. + +| `podIPs` +| `array` +| podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. + +| `podIPs[]` +| `object` +| IP address information for entries in the (plural) PodIPs field. Each entry includes: + IP: An IP address allocated to the pod. Routable at least within the cluster. + +| `qosClass` +| `string` +| The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md + +| `reason` +| `string` +| A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' + +| `startTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. + +|=== +=== .status.conditions +Description:: ++ +-- +Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +PodCondition contains details for the current condition of this pod. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastProbeTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time we probed the condition. + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Last time the condition transitioned from one status to another. + +| `message` +| `string` +| Human-readable message indicating details about last transition. + +| `reason` +| `string` +| Unique, one-word, CamelCase reason for the condition's last transition. + +| `status` +| `string` +| Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions + +| `type` +| `string` +| Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions + +|=== +=== .status.containerStatuses +Description:: ++ +-- +The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status +-- + +Type:: + `array` + + + + +=== .status.containerStatuses[] +Description:: ++ +-- +ContainerStatus contains details for the current status of this container. +-- + +Type:: + `object` + +Required:: + - `name` + - `ready` + - `restartCount` + - `image` + - `imageID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://'. + +| `image` +| `string` +| The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imageID` +| `string` +| ImageID of the container's image. + +| `lastState` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +| `name` +| `string` +| This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. + +| `ready` +| `boolean` +| Specifies whether the container has passed its readiness probe. + +| `restartCount` +| `integer` +| The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. + +| `started` +| `boolean` +| Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. + +| `state` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +|=== +=== .status.containerStatuses[].lastState +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.containerStatuses[].lastState.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.containerStatuses[].lastState.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.containerStatuses[].lastState.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.containerStatuses[].state +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.containerStatuses[].state.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.containerStatuses[].state.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.containerStatuses[].state.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.ephemeralContainerStatuses +Description:: ++ +-- +Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. +-- + +Type:: + `array` + + + + +=== .status.ephemeralContainerStatuses[] +Description:: ++ +-- +ContainerStatus contains details for the current status of this container. +-- + +Type:: + `object` + +Required:: + - `name` + - `ready` + - `restartCount` + - `image` + - `imageID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://'. + +| `image` +| `string` +| The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imageID` +| `string` +| ImageID of the container's image. + +| `lastState` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +| `name` +| `string` +| This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. + +| `ready` +| `boolean` +| Specifies whether the container has passed its readiness probe. + +| `restartCount` +| `integer` +| The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. + +| `started` +| `boolean` +| Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. + +| `state` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +|=== +=== .status.ephemeralContainerStatuses[].lastState +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.ephemeralContainerStatuses[].lastState.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.ephemeralContainerStatuses[].lastState.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.ephemeralContainerStatuses[].lastState.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.ephemeralContainerStatuses[].state +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.ephemeralContainerStatuses[].state.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.ephemeralContainerStatuses[].state.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.ephemeralContainerStatuses[].state.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.initContainerStatuses +Description:: ++ +-- +The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status +-- + +Type:: + `array` + + + + +=== .status.initContainerStatuses[] +Description:: ++ +-- +ContainerStatus contains details for the current status of this container. +-- + +Type:: + `object` + +Required:: + - `name` + - `ready` + - `restartCount` + - `image` + - `imageID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://'. + +| `image` +| `string` +| The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imageID` +| `string` +| ImageID of the container's image. + +| `lastState` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +| `name` +| `string` +| This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. + +| `ready` +| `boolean` +| Specifies whether the container has passed its readiness probe. + +| `restartCount` +| `integer` +| The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. + +| `started` +| `boolean` +| Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. + +| `state` +| `object` +| ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. + +|=== +=== .status.initContainerStatuses[].lastState +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.initContainerStatuses[].lastState.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.initContainerStatuses[].lastState.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.initContainerStatuses[].lastState.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.initContainerStatuses[].state +Description:: ++ +-- +ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `running` +| `object` +| ContainerStateRunning is a running state of a container. + +| `terminated` +| `object` +| ContainerStateTerminated is a terminated state of a container. + +| `waiting` +| `object` +| ContainerStateWaiting is a waiting state of a container. + +|=== +=== .status.initContainerStatuses[].state.running +Description:: ++ +-- +ContainerStateRunning is a running state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container was last (re-)started + +|=== +=== .status.initContainerStatuses[].state.terminated +Description:: ++ +-- +ContainerStateTerminated is a terminated state of a container. +-- + +Type:: + `object` + +Required:: + - `exitCode` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerID` +| `string` +| Container's ID in the format 'docker://' + +| `exitCode` +| `integer` +| Exit status from the last termination of the container + +| `finishedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which the container last terminated + +| `message` +| `string` +| Message regarding the last termination of the container + +| `reason` +| `string` +| (brief) reason from the last termination of the container + +| `signal` +| `integer` +| Signal from the last termination of the container + +| `startedAt` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| Time at which previous execution of the container started + +|=== +=== .status.initContainerStatuses[].state.waiting +Description:: ++ +-- +ContainerStateWaiting is a waiting state of a container. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `message` +| `string` +| Message regarding why the container is not yet running. + +| `reason` +| `string` +| (brief) reason the container is not yet running. + +|=== +=== .status.podIPs +Description:: ++ +-- +podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. +-- + +Type:: + `array` + + + + +=== .status.podIPs[] +Description:: ++ +-- +IP address information for entries in the (plural) PodIPs field. Each entry includes: + IP: An IP address allocated to the pod. Routable at least within the cluster. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `ip` +| `string` +| ip is an IP address (IPv4 or IPv6) assigned to the pod + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/pods` +- `GET`: list or watch objects of kind Pod +* `/api/v1/watch/pods` +- `GET`: watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/pods` +- `DELETE`: delete collection of Pod +- `GET`: list or watch objects of kind Pod +- `POST`: create a Pod +* `/api/v1/watch/namespaces/{namespace}/pods` +- `GET`: watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/pods/{name}` +- `DELETE`: delete a Pod +- `GET`: read the specified Pod +- `PATCH`: partially update the specified Pod +- `PUT`: replace the specified Pod +* `/api/v1/namespaces/{namespace}/pods/{name}/log` +- `GET`: read log of the specified Pod +* `/api/v1/watch/namespaces/{namespace}/pods/{name}` +- `GET`: watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{namespace}/pods/{name}/status` +- `GET`: read status of the specified Pod +- `PATCH`: partially update status of the specified Pod +- `PUT`: replace status of the specified Pod + + +=== /api/v1/pods + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Pod + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodList[`PodList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/pods + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/pods + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodList[`PodList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 201 - Created +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 202 - Accepted +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/pods + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/pods/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Pod +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 202 - Accepted +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Pod + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 201 - Created +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 201 - Created +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/pods/{name}/log + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Pod +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `container` +| `string` +| The container for which to stream logs. Defaults to only container if there is one container in the pod. +| `follow` +| `boolean` +| Follow the log stream of the pod. Defaults to false. +| `insecureSkipTLSVerifyBackend` +| `boolean` +| insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +| `limitBytes` +| `integer` +| If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `previous` +| `boolean` +| Return previous terminated container logs. Defaults to false. +| `sinceSeconds` +| `integer` +| A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +| `tailLines` +| `integer` +| If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +| `timestamps` +| `boolean` +| If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +|=== + +HTTP method:: + `GET` + +Description:: + read log of the specified Pod + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `string` +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/pods/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Pod +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/pods/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Pod +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified Pod + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 201 - Created +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified Pod + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 201 - Created +| xref:../workloads_apis/pod-v1.adoc#pod-v1[`Pod`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/replicaset-apps-v1.adoc b/rest_api/workloads_apis/replicaset-apps-v1.adoc index 70a70be4cb71..676022ac2ed4 100644 --- a/rest_api/workloads_apis/replicaset-apps-v1.adoc +++ b/rest_api/workloads_apis/replicaset-apps-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="replicaset-apps-v1"] = ReplicaSet [apps/v1] ifdef::product-title[] @@ -33,7 +35,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -45,7 +47,7 @@ Type:: | ReplicaSetStatus represents the current status of a ReplicaSet. |=== -..spec +=== .spec Description:: + -- @@ -73,15 +75,15 @@ Required:: | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |=== -..status +=== .status Description:: + -- @@ -129,7 +131,7 @@ Required:: | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -142,7 +144,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -163,7 +165,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | The last time the condition transitioned from one status to another. | `message` @@ -190,19 +192,21 @@ The following API endpoints are available: * `/apis/apps/v1/replicasets` - `GET`: list or watch objects of kind ReplicaSet +* `/apis/apps/v1/watch/replicasets` +- `GET`: watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/replicasets` - `DELETE`: delete collection of ReplicaSet - `GET`: list or watch objects of kind ReplicaSet - `POST`: create a ReplicaSet +* `/apis/apps/v1/watch/namespaces/{namespace}/replicasets` +- `GET`: watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/replicasets/{name}` - `DELETE`: delete a ReplicaSet - `GET`: read the specified ReplicaSet - `PATCH`: partially update the specified ReplicaSet - `PUT`: replace the specified ReplicaSet -* `/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale` -- `GET`: read scale of the specified ReplicaSet -- `PATCH`: partially update scale of the specified ReplicaSet -- `PUT`: replace scale of the specified ReplicaSet +* `/apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}` +- `GET`: watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status` - `GET`: read status of the specified ReplicaSet - `PATCH`: partially update status of the specified ReplicaSet @@ -268,7 +272,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#replicasetlist-apps-v1[`ReplicaSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.ReplicaSetList[`ReplicaSetList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/replicasets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -351,7 +422,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -360,7 +431,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -417,7 +490,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#replicasetlist-apps-v1[`ReplicaSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.ReplicaSetList[`ReplicaSetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -444,7 +519,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema | |=== @@ -453,7 +528,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 201 - Created +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 202 - Accepted +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/replicasets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -510,7 +664,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -519,7 +673,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -534,7 +692,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -564,7 +724,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -573,7 +733,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 201 - Created +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -600,7 +764,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema | |=== @@ -609,11 +773,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 201 - Created +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale +=== /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -621,7 +789,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the Scale +| name of the ReplicaSet | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -631,99 +799,61 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `pretty` +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` | `string` -| If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `GET` - -Description:: - read scale of the specified ReplicaSet - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -|=== - -HTTP method:: - `PATCH` - -Description:: - partially update scale of the specified ReplicaSet +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` | `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` +| If 'true', then the output is pretty printed. +| `resourceVersion` | `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). -| `force` -| `boolean` -| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. -|=== +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| -|=== +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: - `PUT` + `GET` Description:: - replace scale of the specified ReplicaSet - - -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -|=== + watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -| -|=== .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -762,7 +892,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -792,7 +924,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -801,7 +933,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 201 - Created +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -828,7 +964,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema | |=== @@ -837,7 +973,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet apps/v1`] +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 201 - Created +| xref:../workloads_apis/replicaset-apps-v1.adoc#replicaset-apps-v1[`ReplicaSet`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/replicationcontroller-v1.adoc b/rest_api/workloads_apis/replicationcontroller-v1.adoc new file mode 100644 index 000000000000..e7a97040ddc9 --- /dev/null +++ b/rest_api/workloads_apis/replicationcontroller-v1.adoc @@ -0,0 +1,9813 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="replicationcontroller-v1"] += ReplicationController [v1] +ifdef::product-title[] +include::modules/common-attributes.adoc[] +endif::[] + +toc::[] + + +Description:: ++ +-- +ReplicationController represents the configuration of a replication controller. +-- + +Type:: + `object` + + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +| `kind` +| `string` +| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| ReplicationControllerSpec is the specification of a replication controller. + +| `status` +| `object` +| ReplicationControllerStatus represents the current status of a replication controller. + +|=== +=== .spec +Description:: ++ +-- +ReplicationControllerSpec is the specification of a replication controller. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `minReadySeconds` +| `integer` +| Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) + +| `replicas` +| `integer` +| Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +| `selector` +| `object (string)` +| Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +| `template` +| `object` +| PodTemplateSpec describes the data a pod should have when created from a template + +|=== +=== .spec.template +Description:: ++ +-- +PodTemplateSpec describes the data a pod should have when created from a template +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `spec` +| `object` +| PodSpec is a description of a pod. + +|=== +=== .spec.template.spec +Description:: ++ +-- +PodSpec is a description of a pod. +-- + +Type:: + `object` + +Required:: + - `containers` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `activeDeadlineSeconds` +| `integer` +| Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. + +| `affinity` +| `object` +| Affinity is a group of affinity scheduling rules. + +| `automountServiceAccountToken` +| `boolean` +| AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + +| `containers` +| `array` +| List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + +| `containers[]` +| `object` +| A single application container that you want to run within a pod. + +| `dnsConfig` +| `object` +| PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + +| `dnsPolicy` +| `string` +| Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + +| `enableServiceLinks` +| `boolean` +| EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. + +| `ephemeralContainers` +| `array` +| List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + +| `ephemeralContainers[]` +| `object` +| An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + +| `hostAliases` +| `array` +| HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. + +| `hostAliases[]` +| `object` +| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + +| `hostIPC` +| `boolean` +| Use the host's ipc namespace. Optional: Default to false. + +| `hostNetwork` +| `boolean` +| Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + +| `hostPID` +| `boolean` +| Use the host's pid namespace. Optional: Default to false. + +| `hostname` +| `string` +| Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + +| `imagePullSecrets` +| `array` +| ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + +| `imagePullSecrets[]` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `initContainers` +| `array` +| List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + +| `initContainers[]` +| `object` +| A single application container that you want to run within a pod. + +| `nodeName` +| `string` +| NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + +| `nodeSelector` +| `object (string)` +| NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + +| `overhead` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature. + +| `preemptionPolicy` +| `string` +| PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +| `priority` +| `integer` +| The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + +| `priorityClassName` +| `string` +| If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + +| `readinessGates` +| `array` +| If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates + +| `readinessGates[]` +| `object` +| PodReadinessGate contains the reference to a pod condition + +| `restartPolicy` +| `string` +| Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + +| `runtimeClassName` +| `string` +| RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14. + +| `schedulerName` +| `string` +| If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. + +| `securityContext` +| `object` +| PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + +| `serviceAccount` +| `string` +| DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. + +| `serviceAccountName` +| `string` +| ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + +| `setHostnameAsFQDN` +| `boolean` +| If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. + +| `shareProcessNamespace` +| `boolean` +| Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + +| `subdomain` +| `string` +| If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + +| `tolerations` +| `array` +| If specified, the pod's tolerations. + +| `tolerations[]` +| `object` +| The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + +| `topologySpreadConstraints` +| `array` +| TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. + +| `topologySpreadConstraints[]` +| `object` +| TopologySpreadConstraint specifies how to spread matching pods among the given topology. + +| `volumes` +| `array` +| List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes + +| `volumes[]` +| `object` +| Volume represents a named volume in a pod that may be accessed by any container in the pod. + +|=== +=== .spec.template.spec.affinity +Description:: ++ +-- +Affinity is a group of affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeAffinity` +| `object` +| Node affinity is a group of node affinity scheduling rules. + +| `podAffinity` +| `object` +| Pod affinity is a group of inter pod affinity scheduling rules. + +| `podAntiAffinity` +| `object` +| Pod anti affinity is a group of inter pod anti affinity scheduling rules. + +|=== +=== .spec.template.spec.affinity.nodeAffinity +Description:: ++ +-- +Node affinity is a group of node affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `object` +| A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). +-- + +Type:: + `object` + +Required:: + - `weight` + - `preference` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preference` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +| `weight` +| `integer` +| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. +-- + +Type:: + `object` + +Required:: + - `nodeSelectorTerms` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nodeSelectorTerms` +| `array` +| Required. A list of node selector terms. The terms are ORed. + +| `nodeSelectorTerms[]` +| `object` +| A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms +Description:: ++ +-- +Required. A list of node selector terms. The terms are ORed. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[] +Description:: ++ +-- +A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `matchExpressions` +| `array` +| A list of node selector requirements by node's labels. + +| `matchExpressions[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +| `matchFields` +| `array` +| A list of node selector requirements by node's fields. + +| `matchFields[]` +| `object` +| A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions +Description:: ++ +-- +A list of node selector requirements by node's labels. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields +Description:: ++ +-- +A list of node selector requirements by node's fields. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[] +Description:: ++ +-- +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +-- + +Type:: + `object` + +Required:: + - `key` + - `operator` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The label key that the selector applies to. + +| `operator` +| `string` +| Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +| `values` +| `array (string)` +| An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +|=== +=== .spec.template.spec.affinity.podAffinity +Description:: ++ +-- +Pod affinity is a group of inter pod affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.template.spec.affinity.podAntiAffinity +Description:: ++ +-- +Pod anti affinity is a group of inter pod anti affinity scheduling rules. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `preferredDuringSchedulingIgnoredDuringExecution` +| `array` +| The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +| `preferredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + +| `requiredDuringSchedulingIgnoredDuringExecution` +| `array` +| If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +| `requiredDuringSchedulingIgnoredDuringExecution[]` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +|=== +=== .spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) +-- + +Type:: + `object` + +Required:: + - `weight` + - `podAffinityTerm` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `podAffinityTerm` +| `object` +| Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + +| `weight` +| `integer` +| weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +|=== +=== .spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution +Description:: ++ +-- +If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[] +Description:: ++ +-- +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running +-- + +Type:: + `object` + +Required:: + - `topologyKey` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over a set of resources, in this case pods. + +| `namespaceSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +| `namespaces` +| `array (string)` +| namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +| `topologyKey` +| `string` +| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + +|=== +=== .spec.template.spec.containers +Description:: ++ +-- +List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.template.spec.containers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.template.spec.containers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.template.spec.containers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.template.spec.containers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.template.spec.containers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.template.spec.containers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.template.spec.containers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.template.spec.containers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.template.spec.containers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.template.spec.containers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.template.spec.containers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.containers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.containers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.containers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.containers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.containers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.containers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.containers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.containers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.containers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.containers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.containers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.containers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.template.spec.containers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.containers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.containers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.containers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.containers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.template.spec.containers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.template.spec.containers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.template.spec.containers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.template.spec.containers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.template.spec.containers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.template.spec.containers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.containers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.containers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.containers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.containers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.containers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.template.spec.containers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.containers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.template.spec.dnsConfig +Description:: ++ +-- +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `nameservers` +| `array (string)` +| A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + +| `options` +| `array` +| A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + +| `options[]` +| `object` +| PodDNSConfigOption defines DNS resolver options of a pod. + +| `searches` +| `array (string)` +| A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + +|=== +=== .spec.template.spec.dnsConfig.options +Description:: ++ +-- +A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.dnsConfig.options[] +Description:: ++ +-- +PodDNSConfigOption defines DNS resolver options of a pod. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Required. + +| `value` +| `string` +| + +|=== +=== .spec.template.spec.ephemeralContainers +Description:: ++ +-- +List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[] +Description:: ++ +-- +An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. + +| `ports` +| `array` +| Ports are not allowed for ephemeral containers. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `targetContainerName` +| `string` +| If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.template.spec.ephemeralContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.template.spec.ephemeralContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.template.spec.ephemeralContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.template.spec.ephemeralContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.template.spec.ephemeralContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.ephemeralContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.ephemeralContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.ephemeralContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.ephemeralContainers[].ports +Description:: ++ +-- +Ports are not allowed for ephemeral containers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.template.spec.ephemeralContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.ephemeralContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.ephemeralContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.ephemeralContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.template.spec.ephemeralContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.template.spec.ephemeralContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.template.spec.ephemeralContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.template.spec.ephemeralContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.template.spec.ephemeralContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.ephemeralContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.ephemeralContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.ephemeralContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.template.spec.ephemeralContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.ephemeralContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.template.spec.hostAliases +Description:: ++ +-- +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.hostAliases[] +Description:: ++ +-- +HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `hostnames` +| `array (string)` +| Hostnames for the above IP address. + +| `ip` +| `string` +| IP address of the host file entry. + +|=== +=== .spec.template.spec.imagePullSecrets +Description:: ++ +-- +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +-- + +Type:: + `array` + + + + +=== .spec.template.spec.imagePullSecrets[] +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.initContainers +Description:: ++ +-- +List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[] +Description:: ++ +-- +A single application container that you want to run within a pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `args` +| `array (string)` +| Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `command` +| `array (string)` +| Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +| `env` +| `array` +| List of environment variables to set in the container. Cannot be updated. + +| `env[]` +| `object` +| EnvVar represents an environment variable present in a Container. + +| `envFrom` +| `array` +| List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +| `envFrom[]` +| `object` +| EnvFromSource represents the source of a set of ConfigMaps + +| `image` +| `string` +| Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +| `imagePullPolicy` +| `string` +| Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +| `lifecycle` +| `object` +| Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +| `livenessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `name` +| `string` +| Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +| `ports` +| `array` +| List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +| `ports[]` +| `object` +| ContainerPort represents a network port in a single container. + +| `readinessProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `securityContext` +| `object` +| SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +| `startupProbe` +| `object` +| Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +| `stdin` +| `boolean` +| Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +| `stdinOnce` +| `boolean` +| Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +| `terminationMessagePath` +| `string` +| Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +| `terminationMessagePolicy` +| `string` +| Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +| `tty` +| `boolean` +| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + +| `volumeDevices` +| `array` +| volumeDevices is the list of block devices to be used by the container. + +| `volumeDevices[]` +| `object` +| volumeDevice describes a mapping of a raw block device within a container. + +| `volumeMounts` +| `array` +| Pod volumes to mount into the container's filesystem. Cannot be updated. + +| `volumeMounts[]` +| `object` +| VolumeMount describes a mounting of a Volume within a container. + +| `workingDir` +| `string` +| Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +|=== +=== .spec.template.spec.initContainers[].env +Description:: ++ +-- +List of environment variables to set in the container. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].env[] +Description:: ++ +-- +EnvVar represents an environment variable present in a Container. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the environment variable. Must be a C_IDENTIFIER. + +| `value` +| `string` +| Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +| `valueFrom` +| `object` +| EnvVarSource represents a source for the value of an EnvVar. + +|=== +=== .spec.template.spec.initContainers[].env[].valueFrom +Description:: ++ +-- +EnvVarSource represents a source for the value of an EnvVar. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapKeyRef` +| `object` +| Selects a key from a ConfigMap. + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +| `secretKeyRef` +| `object` +| SecretKeySelector selects a key of a Secret. + +|=== +=== .spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef +Description:: ++ +-- +Selects a key from a ConfigMap. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to select. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its key must be defined + +|=== +=== .spec.template.spec.initContainers[].env[].valueFrom.fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef +Description:: ++ +-- +SecretKeySelector selects a key of a Secret. +-- + +Type:: + `object` + +Required:: + - `key` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key of the secret to select from. Must be a valid secret key. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.template.spec.initContainers[].envFrom +Description:: ++ +-- +List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].envFrom[] +Description:: ++ +-- +EnvFromSource represents the source of a set of ConfigMaps +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMapRef` +| `object` +| ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +| `prefix` +| `string` +| An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + +| `secretRef` +| `object` +| SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +|=== +=== .spec.template.spec.initContainers[].envFrom[].configMapRef +Description:: ++ +-- +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap must be defined + +|=== +=== .spec.template.spec.initContainers[].envFrom[].secretRef +Description:: ++ +-- +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret must be defined + +|=== +=== .spec.template.spec.initContainers[].lifecycle +Description:: ++ +-- +Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `postStart` +| `object` +| Handler defines a specific action that should be taken + +| `preStop` +| `object` +| Handler defines a specific action that should be taken + +|=== +=== .spec.template.spec.initContainers[].lifecycle.postStart +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.initContainers[].lifecycle.postStart.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.initContainers[].lifecycle.postStart.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.initContainers[].lifecycle.preStop +Description:: ++ +-- +Handler defines a specific action that should be taken +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +|=== +=== .spec.template.spec.initContainers[].lifecycle.preStop.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.initContainers[].lifecycle.preStop.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.initContainers[].livenessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.initContainers[].livenessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.initContainers[].livenessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.initContainers[].livenessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.initContainers[].ports +Description:: ++ +-- +List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].ports[] +Description:: ++ +-- +ContainerPort represents a network port in a single container. +-- + +Type:: + `object` + +Required:: + - `containerPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerPort` +| `integer` +| Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + +| `hostIP` +| `string` +| What host IP to bind the external port to. + +| `hostPort` +| `integer` +| Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +| `name` +| `string` +| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +| `protocol` +| `string` +| Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + +|=== +=== .spec.template.spec.initContainers[].readinessProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.initContainers[].readinessProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.initContainers[].readinessProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.initContainers[].readinessProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.initContainers[].resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.template.spec.initContainers[].securityContext +Description:: ++ +-- +SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowPrivilegeEscalation` +| `boolean` +| AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +| `capabilities` +| `object` +| Adds and removes POSIX capabilities from running containers. + +| `privileged` +| `boolean` +| Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +| `procMount` +| `string` +| procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +| `readOnlyRootFilesystem` +| `boolean` +| Whether this container has a read-only root filesystem. Default is false. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.template.spec.initContainers[].securityContext.capabilities +Description:: ++ +-- +Adds and removes POSIX capabilities from running containers. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `add` +| `array (string)` +| Added capabilities + +| `drop` +| `array (string)` +| Removed capabilities + +|=== +=== .spec.template.spec.initContainers[].securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.template.spec.initContainers[].securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.template.spec.initContainers[].securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.template.spec.initContainers[].startupProbe +Description:: ++ +-- +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `exec` +| `object` +| ExecAction describes a "run in container" action. + +| `failureThreshold` +| `integer` +| Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + +| `httpGet` +| `object` +| HTTPGetAction describes an action based on HTTP Get requests. + +| `initialDelaySeconds` +| `integer` +| Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +| `periodSeconds` +| `integer` +| How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + +| `successThreshold` +| `integer` +| Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +| `tcpSocket` +| `object` +| TCPSocketAction describes an action based on opening a socket + +| `terminationGracePeriodSeconds` +| `integer` +| Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. + +| `timeoutSeconds` +| `integer` +| Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +|=== +=== .spec.template.spec.initContainers[].startupProbe.exec +Description:: ++ +-- +ExecAction describes a "run in container" action. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `command` +| `array (string)` +| Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +|=== +=== .spec.template.spec.initContainers[].startupProbe.httpGet +Description:: ++ +-- +HTTPGetAction describes an action based on HTTP Get requests. +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + +| `httpHeaders` +| `array` +| Custom headers to set in the request. HTTP allows repeated headers. + +| `httpHeaders[]` +| `object` +| HTTPHeader describes a custom header to be used in HTTP probes + +| `path` +| `string` +| Path to access on the HTTP server. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +| `scheme` +| `string` +| Scheme to use for connecting to the host. Defaults to HTTP. + +|=== +=== .spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders +Description:: ++ +-- +Custom headers to set in the request. HTTP allows repeated headers. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[] +Description:: ++ +-- +HTTPHeader describes a custom header to be used in HTTP probes +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| The header field name + +| `value` +| `string` +| The header field value + +|=== +=== .spec.template.spec.initContainers[].startupProbe.tcpSocket +Description:: ++ +-- +TCPSocketAction describes an action based on opening a socket +-- + +Type:: + `object` + +Required:: + - `port` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `host` +| `string` +| Optional: Host name to connect to, defaults to the pod IP. + +| `port` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`] +| Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +|=== +=== .spec.template.spec.initContainers[].volumeDevices +Description:: ++ +-- +volumeDevices is the list of block devices to be used by the container. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].volumeDevices[] +Description:: ++ +-- +volumeDevice describes a mapping of a raw block device within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `devicePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `devicePath` +| `string` +| devicePath is the path inside of the container that the device will be mapped to. + +| `name` +| `string` +| name must match the name of a persistentVolumeClaim in the pod + +|=== +=== .spec.template.spec.initContainers[].volumeMounts +Description:: ++ +-- +Pod volumes to mount into the container's filesystem. Cannot be updated. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.initContainers[].volumeMounts[] +Description:: ++ +-- +VolumeMount describes a mounting of a Volume within a container. +-- + +Type:: + `object` + +Required:: + - `name` + - `mountPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `mountPath` +| `string` +| Path within the container at which the volume should be mounted. Must not contain ':'. + +| `mountPropagation` +| `string` +| mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + +| `name` +| `string` +| This must match the Name of a Volume. + +| `readOnly` +| `boolean` +| Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + +| `subPath` +| `string` +| Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + +| `subPathExpr` +| `string` +| Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +|=== +=== .spec.template.spec.readinessGates +Description:: ++ +-- +If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates +-- + +Type:: + `array` + + + + +=== .spec.template.spec.readinessGates[] +Description:: ++ +-- +PodReadinessGate contains the reference to a pod condition +-- + +Type:: + `object` + +Required:: + - `conditionType` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditionType` +| `string` +| ConditionType refers to a condition in the pod's condition list with matching type. + +|=== +=== .spec.template.spec.securityContext +Description:: ++ +-- +PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsGroup` +| `integer` +| A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: + +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- + +If unset, the Kubelet will not modify the ownership and permissions of any volume. + +| `fsGroupChangePolicy` +| `string` +| fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + +| `runAsGroup` +| `integer` +| The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `runAsNonRoot` +| `boolean` +| Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +| `runAsUser` +| `integer` +| The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +| `seLinuxOptions` +| `object` +| SELinuxOptions are the labels to be applied to the container + +| `seccompProfile` +| `object` +| SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + +| `supplementalGroups` +| `array (integer)` +| A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. + +| `sysctls` +| `array` +| Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. + +| `sysctls[]` +| `object` +| Sysctl defines a kernel parameter to be set + +| `windowsOptions` +| `object` +| WindowsSecurityContextOptions contain Windows-specific options and credentials. + +|=== +=== .spec.template.spec.securityContext.seLinuxOptions +Description:: ++ +-- +SELinuxOptions are the labels to be applied to the container +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `level` +| `string` +| Level is SELinux level label that applies to the container. + +| `role` +| `string` +| Role is a SELinux role label that applies to the container. + +| `type` +| `string` +| Type is a SELinux type label that applies to the container. + +| `user` +| `string` +| User is a SELinux user label that applies to the container. + +|=== +=== .spec.template.spec.securityContext.seccompProfile +Description:: ++ +-- +SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +-- + +Type:: + `object` + +Required:: + - `type` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `localhostProfile` +| `string` +| localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +| `type` +| `string` +| type indicates which kind of seccomp profile will be applied. Valid options are: + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +|=== +=== .spec.template.spec.securityContext.sysctls +Description:: ++ +-- +Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.securityContext.sysctls[] +Description:: ++ +-- +Sysctl defines a kernel parameter to be set +-- + +Type:: + `object` + +Required:: + - `name` + - `value` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of a property to set + +| `value` +| `string` +| Value of a property to set + +|=== +=== .spec.template.spec.securityContext.windowsOptions +Description:: ++ +-- +WindowsSecurityContextOptions contain Windows-specific options and credentials. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `gmsaCredentialSpec` +| `string` +| GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +| `gmsaCredentialSpecName` +| `string` +| GMSACredentialSpecName is the name of the GMSA credential spec to use. + +| `hostProcess` +| `boolean` +| HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. + +| `runAsUserName` +| `string` +| The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +|=== +=== .spec.template.spec.tolerations +Description:: ++ +-- +If specified, the pod's tolerations. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.tolerations[] +Description:: ++ +-- +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `effect` +| `string` +| Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + +| `key` +| `string` +| Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + +| `operator` +| `string` +| Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + +| `tolerationSeconds` +| `integer` +| TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + +| `value` +| `string` +| Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. + +|=== +=== .spec.template.spec.topologySpreadConstraints +Description:: ++ +-- +TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.topologySpreadConstraints[] +Description:: ++ +-- +TopologySpreadConstraint specifies how to spread matching pods among the given topology. +-- + +Type:: + `object` + +Required:: + - `maxSkew` + - `topologyKey` + - `whenUnsatisfiable` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `labelSelector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + +| `maxSkew` +| `integer` +| MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: \| zone1 \| zone2 \| zone3 \| \| P \| P \| \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. + +| `topologyKey` +| `string` +| TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + +| `whenUnsatisfiable` +| `string` +| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, + but giving higher precedence to topologies that would help reduce the + skew. +A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + +|=== +=== .spec.template.spec.volumes +Description:: ++ +-- +List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[] +Description:: ++ +-- +Volume represents a named volume in a pod that may be accessed by any container in the pod. +-- + +Type:: + `object` + +Required:: + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `awsElasticBlockStore` +| `object` +| Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + +| `azureDisk` +| `object` +| AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +| `azureFile` +| `object` +| AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +| `cephfs` +| `object` +| Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +| `cinder` +| `object` +| Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +| `configMap` +| `object` +| Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. + +| `csi` +| `object` +| Represents a source location of a volume to mount, managed by an external CSI driver + +| `downwardAPI` +| `object` +| DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. + +| `emptyDir` +| `object` +| Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. + +| `ephemeral` +| `object` +| Represents an ephemeral volume that is handled by a normal storage driver. + +| `fc` +| `object` +| Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + +| `flexVolume` +| `object` +| FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +| `flocker` +| `object` +| Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + +| `gcePersistentDisk` +| `object` +| Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + +| `gitRepo` +| `object` +| Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + +| `glusterfs` +| `object` +| Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + +| `hostPath` +| `object` +| Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + +| `iscsi` +| `object` +| Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +| `name` +| `string` +| Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `nfs` +| `object` +| Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + +| `persistentVolumeClaim` +| `object` +| PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + +| `photonPersistentDisk` +| `object` +| Represents a Photon Controller persistent disk resource. + +| `portworxVolume` +| `object` +| PortworxVolumeSource represents a Portworx volume resource. + +| `projected` +| `object` +| Represents a projected volume source + +| `quobyte` +| `object` +| Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + +| `rbd` +| `object` +| Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + +| `scaleIO` +| `object` +| ScaleIOVolumeSource represents a persistent ScaleIO volume + +| `secret` +| `object` +| Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. + +| `storageos` +| `object` +| Represents a StorageOS persistent volume resource. + +| `vsphereVolume` +| `object` +| Represents a vSphere volume resource. + +|=== +=== .spec.template.spec.volumes[].awsElasticBlockStore +Description:: ++ +-- +Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + +| `readOnly` +| `boolean` +| Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +| `volumeID` +| `string` +| Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +|=== +=== .spec.template.spec.volumes[].azureDisk +Description:: ++ +-- +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `diskName` + - `diskURI` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `cachingMode` +| `string` +| Host Caching mode: None, Read Only, Read Write. + +| `diskName` +| `string` +| The Name of the data disk in the blob storage + +| `diskURI` +| `string` +| The URI the data disk in the blob storage + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `kind` +| `string` +| Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +|=== +=== .spec.template.spec.volumes[].azureFile +Description:: ++ +-- +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +-- + +Type:: + `object` + +Required:: + - `secretName` + - `shareName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretName` +| `string` +| the name of secret that contains Azure Storage Account Name and Key + +| `shareName` +| `string` +| Share Name + +|=== +=== .spec.template.spec.volumes[].cephfs +Description:: ++ +-- +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `monitors` +| `array (string)` +| Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `path` +| `string` +| Optional: Used as the mounted root, rather than the full Ceph tree, default is / + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretFile` +| `string` +| Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +|=== +=== .spec.template.spec.volumes[].cephfs.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].cinder +Description:: ++ +-- +Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeID` +| `string` +| volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +|=== +=== .spec.template.spec.volumes[].cinder.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .spec.template.spec.volumes[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.template.spec.volumes[].csi +Description:: ++ +-- +Represents a source location of a volume to mount, managed by an external CSI driver +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + +| `fsType` +| `string` +| Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + +| `nodePublishSecretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `readOnly` +| `boolean` +| Specifies a read-only configuration for the volume. Defaults to false (read/write). + +| `volumeAttributes` +| `object (string)` +| VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + +|=== +=== .spec.template.spec.volumes[].csi.nodePublishSecretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].downwardAPI +Description:: ++ +-- +DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| Items is a list of downward API volume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .spec.template.spec.volumes[].downwardAPI.items +Description:: ++ +-- +Items is a list of downward API volume file +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .spec.template.spec.volumes[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.template.spec.volumes[].emptyDir +Description:: ++ +-- +Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `medium` +| `string` +| What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + +| `sizeLimit` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + +|=== +=== .spec.template.spec.volumes[].ephemeral +Description:: ++ +-- +Represents an ephemeral volume that is handled by a normal storage driver. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `volumeClaimTemplate` +| `object` +| PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + +|=== +=== .spec.template.spec.volumes[].ephemeral.volumeClaimTemplate +Description:: ++ +-- +PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. +-- + +Type:: + `object` + +Required:: + - `spec` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `metadata` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] +| May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + +| `spec` +| `object` +| PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + +|=== +=== .spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec +Description:: ++ +-- +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `accessModes` +| `array (string)` +| AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +| `dataSource` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `dataSourceRef` +| `object` +| TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +| `resources` +| `object` +| ResourceRequirements describes the compute resource requirements. + +| `selector` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] +| A label query over volumes to consider for binding. + +| `storageClassName` +| `string` +| Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + +| `volumeMode` +| `string` +| volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + +| `volumeName` +| `string` +| VolumeName is the binding reference to the PersistentVolume backing this claim. + +|=== +=== .spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef +Description:: ++ +-- +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiGroup` +| `string` +| APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +| `kind` +| `string` +| Kind is the type of resource being referenced + +| `name` +| `string` +| Name is the name of resource being referenced + +|=== +=== .spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources +Description:: ++ +-- +ResourceRequirements describes the compute resource requirements. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `limits` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +| `requests` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`object (Quantity)`] +| Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +|=== +=== .spec.template.spec.volumes[].fc +Description:: ++ +-- +Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `lun` +| `integer` +| Optional: FC target lun number + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `targetWWNs` +| `array (string)` +| Optional: FC target worldwide names (WWNs) + +| `wwids` +| `array (string)` +| Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + +|=== +=== .spec.template.spec.volumes[].flexVolume +Description:: ++ +-- +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +-- + +Type:: + `object` + +Required:: + - `driver` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `driver` +| `string` +| Driver is the name of the driver to use for this volume. + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +| `options` +| `object (string)` +| Optional: Extra command options if any. + +| `readOnly` +| `boolean` +| Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +|=== +=== .spec.template.spec.volumes[].flexVolume.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].flocker +Description:: ++ +-- +Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `datasetName` +| `string` +| Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + +| `datasetUUID` +| `string` +| UUID of the dataset. This is unique identifier of a Flocker dataset + +|=== +=== .spec.template.spec.volumes[].gcePersistentDisk +Description:: ++ +-- +Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `pdName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `partition` +| `integer` +| The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `pdName` +| `string` +| Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +|=== +=== .spec.template.spec.volumes[].gitRepo +Description:: ++ +-- +Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. +-- + +Type:: + `object` + +Required:: + - `repository` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `directory` +| `string` +| Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + +| `repository` +| `string` +| Repository URL + +| `revision` +| `string` +| Commit hash for the specified revision. + +|=== +=== .spec.template.spec.volumes[].glusterfs +Description:: ++ +-- +Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `endpoints` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `endpoints` +| `string` +| EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `path` +| `string` +| Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +| `readOnly` +| `boolean` +| ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +|=== +=== .spec.template.spec.volumes[].hostPath +Description:: ++ +-- +Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +| `type` +| `string` +| Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +|=== +=== .spec.template.spec.volumes[].iscsi +Description:: ++ +-- +Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `targetPortal` + - `iqn` + - `lun` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `chapAuthDiscovery` +| `boolean` +| whether support iSCSI Discovery CHAP authentication + +| `chapAuthSession` +| `boolean` +| whether support iSCSI Session CHAP authentication + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +| `initiatorName` +| `string` +| Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +| `iqn` +| `string` +| Target iSCSI Qualified Name. + +| `iscsiInterface` +| `string` +| iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + +| `lun` +| `integer` +| iSCSI Target Lun number. + +| `portals` +| `array (string)` +| iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `targetPortal` +| `string` +| iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +|=== +=== .spec.template.spec.volumes[].iscsi.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].nfs +Description:: ++ +-- +Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `server` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `path` +| `string` +| Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `readOnly` +| `boolean` +| ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +| `server` +| `string` +| Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +|=== +=== .spec.template.spec.volumes[].persistentVolumeClaim +Description:: ++ +-- +PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). +-- + +Type:: + `object` + +Required:: + - `claimName` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `claimName` +| `string` +| ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +| `readOnly` +| `boolean` +| Will force the ReadOnly setting in VolumeMounts. Default false. + +|=== +=== .spec.template.spec.volumes[].photonPersistentDisk +Description:: ++ +-- +Represents a Photon Controller persistent disk resource. +-- + +Type:: + `object` + +Required:: + - `pdID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `pdID` +| `string` +| ID that identifies Photon Controller persistent disk + +|=== +=== .spec.template.spec.volumes[].portworxVolume +Description:: ++ +-- +PortworxVolumeSource represents a Portworx volume resource. +-- + +Type:: + `object` + +Required:: + - `volumeID` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `volumeID` +| `string` +| VolumeID uniquely identifies a Portworx volume + +|=== +=== .spec.template.spec.volumes[].projected +Description:: ++ +-- +Represents a projected volume source +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `sources` +| `array` +| list of volume projections + +| `sources[]` +| `object` +| Projection that may be projected along with other supported volume types + +|=== +=== .spec.template.spec.volumes[].projected.sources +Description:: ++ +-- +list of volume projections +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].projected.sources[] +Description:: ++ +-- +Projection that may be projected along with other supported volume types +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `configMap` +| `object` +| Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. + +| `downwardAPI` +| `object` +| Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. + +| `secret` +| `object` +| Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. + +| `serviceAccountToken` +| `object` +| ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + +|=== +=== .spec.template.spec.volumes[].projected.sources[].configMap +Description:: ++ +-- +Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the ConfigMap or its keys must be defined + +|=== +=== .spec.template.spec.volumes[].projected.sources[].configMap.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].projected.sources[].configMap.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.template.spec.volumes[].projected.sources[].downwardAPI +Description:: ++ +-- +Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| Items is a list of DownwardAPIVolume file + +| `items[]` +| `object` +| DownwardAPIVolumeFile represents information to create the file containing the pod field + +|=== +=== .spec.template.spec.volumes[].projected.sources[].downwardAPI.items +Description:: ++ +-- +Items is a list of DownwardAPIVolume file +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].projected.sources[].downwardAPI.items[] +Description:: ++ +-- +DownwardAPIVolumeFile represents information to create the file containing the pod field +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fieldRef` +| `object` +| ObjectFieldSelector selects an APIVersioned field of an object. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +| `resourceFieldRef` +| `object` +| ResourceFieldSelector represents container resources (cpu, memory) and their output format + +|=== +=== .spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef +Description:: ++ +-- +ObjectFieldSelector selects an APIVersioned field of an object. +-- + +Type:: + `object` + +Required:: + - `fieldPath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| Version of the schema the FieldPath is written in terms of, defaults to "v1". + +| `fieldPath` +| `string` +| Path of the field to select in the specified API version. + +|=== +=== .spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef +Description:: ++ +-- +ResourceFieldSelector represents container resources (cpu, memory) and their output format +-- + +Type:: + `object` + +Required:: + - `resource` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `containerName` +| `string` +| Container name: required for volumes, optional for env vars + +| `divisor` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.api.resource.Quantity[`Quantity`] +| Specifies the output format of the exposed resources, defaults to "1" + +| `resource` +| `string` +| Required: resource to select + +|=== +=== .spec.template.spec.volumes[].projected.sources[].secret +Description:: ++ +-- +Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +| `optional` +| `boolean` +| Specify whether the Secret or its key must be defined + +|=== +=== .spec.template.spec.volumes[].projected.sources[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].projected.sources[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.template.spec.volumes[].projected.sources[].serviceAccountToken +Description:: ++ +-- +ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). +-- + +Type:: + `object` + +Required:: + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `audience` +| `string` +| Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + +| `expirationSeconds` +| `integer` +| ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + +| `path` +| `string` +| Path is the path relative to the mount point of the file to project the token into. + +|=== +=== .spec.template.spec.volumes[].quobyte +Description:: ++ +-- +Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `registry` + - `volume` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `group` +| `string` +| Group to map volume access to Default is no group + +| `readOnly` +| `boolean` +| ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + +| `registry` +| `string` +| Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + +| `tenant` +| `string` +| Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + +| `user` +| `string` +| User to map volume access to Defaults to serivceaccount user + +| `volume` +| `string` +| Volume is a string that references an already created Quobyte volume by name. + +|=== +=== .spec.template.spec.volumes[].rbd +Description:: ++ +-- +Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + +Required:: + - `monitors` + - `image` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +| `image` +| `string` +| The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `keyring` +| `string` +| Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `monitors` +| `array (string)` +| A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `pool` +| `string` +| The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `readOnly` +| `boolean` +| ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `user` +| `string` +| The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +|=== +=== .spec.template.spec.volumes[].rbd.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].scaleIO +Description:: ++ +-- +ScaleIOVolumeSource represents a persistent ScaleIO volume +-- + +Type:: + `object` + +Required:: + - `gateway` + - `system` + - `secretRef` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + +| `gateway` +| `string` +| The host address of the ScaleIO API Gateway. + +| `protectionDomain` +| `string` +| The name of the ScaleIO Protection Domain for the configured storage. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `sslEnabled` +| `boolean` +| Flag to enable/disable SSL communication with Gateway, default false + +| `storageMode` +| `string` +| Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + +| `storagePool` +| `string` +| The ScaleIO Storage Pool associated with the protection domain. + +| `system` +| `string` +| The name of the storage system as configured in ScaleIO. + +| `volumeName` +| `string` +| The name of a volume already created in the ScaleIO system that is associated with this volume source. + +|=== +=== .spec.template.spec.volumes[].scaleIO.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].secret +Description:: ++ +-- +Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `defaultMode` +| `integer` +| Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `items` +| `array` +| If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +| `items[]` +| `object` +| Maps a string key to a path within a volume. + +| `optional` +| `boolean` +| Specify whether the Secret or its keys must be defined + +| `secretName` +| `string` +| Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + +|=== +=== .spec.template.spec.volumes[].secret.items +Description:: ++ +-- +If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +-- + +Type:: + `array` + + + + +=== .spec.template.spec.volumes[].secret.items[] +Description:: ++ +-- +Maps a string key to a path within a volume. +-- + +Type:: + `object` + +Required:: + - `key` + - `path` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `key` +| `string` +| The key to project. + +| `mode` +| `integer` +| Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +| `path` +| `string` +| The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +|=== +=== .spec.template.spec.volumes[].storageos +Description:: ++ +-- +Represents a StorageOS persistent volume resource. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `readOnly` +| `boolean` +| Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +| `secretRef` +| `object` +| LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +| `volumeName` +| `string` +| VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + +| `volumeNamespace` +| `string` +| VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +|=== +=== .spec.template.spec.volumes[].storageos.secretRef +Description:: ++ +-- +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `name` +| `string` +| Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +|=== +=== .spec.template.spec.volumes[].vsphereVolume +Description:: ++ +-- +Represents a vSphere volume resource. +-- + +Type:: + `object` + +Required:: + - `volumePath` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `fsType` +| `string` +| Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +| `storagePolicyID` +| `string` +| Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + +| `storagePolicyName` +| `string` +| Storage Policy Based Management (SPBM) profile name. + +| `volumePath` +| `string` +| Path that identifies vSphere volume vmdk + +|=== +=== .status +Description:: ++ +-- +ReplicationControllerStatus represents the current status of a replication controller. +-- + +Type:: + `object` + +Required:: + - `replicas` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `availableReplicas` +| `integer` +| The number of available replicas (ready for at least minReadySeconds) for this replication controller. + +| `conditions` +| `array` +| Represents the latest available observations of a replication controller's current state. + +| `conditions[]` +| `object` +| ReplicationControllerCondition describes the state of a replication controller at a certain point. + +| `fullyLabeledReplicas` +| `integer` +| The number of pods that have labels matching the labels of the pod template of the replication controller. + +| `observedGeneration` +| `integer` +| ObservedGeneration reflects the generation of the most recently observed replication controller. + +| `readyReplicas` +| `integer` +| The number of ready replicas for this replication controller. + +| `replicas` +| `integer` +| Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +|=== +=== .status.conditions +Description:: ++ +-- +Represents the latest available observations of a replication controller's current state. +-- + +Type:: + `array` + + + + +=== .status.conditions[] +Description:: ++ +-- +ReplicationControllerCondition describes the state of a replication controller at a certain point. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastTransitionTime` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] +| The last time the condition transitioned from one status to another. + +| `message` +| `string` +| A human readable message indicating details about the transition. + +| `reason` +| `string` +| The reason for the condition's last transition. + +| `status` +| `string` +| Status of the condition, one of True, False, Unknown. + +| `type` +| `string` +| Type of replication controller condition. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/api/v1/replicationcontrollers` +- `GET`: list or watch objects of kind ReplicationController +* `/api/v1/watch/replicationcontrollers` +- `GET`: watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/replicationcontrollers` +- `DELETE`: delete collection of ReplicationController +- `GET`: list or watch objects of kind ReplicationController +- `POST`: create a ReplicationController +* `/api/v1/watch/namespaces/{namespace}/replicationcontrollers` +- `GET`: watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead. +* `/api/v1/namespaces/{namespace}/replicationcontrollers/{name}` +- `DELETE`: delete a ReplicationController +- `GET`: read the specified ReplicationController +- `PATCH`: partially update the specified ReplicationController +- `PUT`: replace the specified ReplicationController +* `/api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}` +- `GET`: watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` +- `GET`: read status of the specified ReplicationController +- `PATCH`: partially update status of the specified ReplicationController +- `PUT`: replace status of the specified ReplicationController + + +=== /api/v1/replicationcontrollers + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ReplicationController + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ReplicationControllerList[`ReplicationControllerList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/replicationcontrollers + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/replicationcontrollers + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.api.core.v1.ReplicationControllerList[`ReplicationControllerList`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 201 - Created +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 202 - Accepted +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/replicationcontrollers + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/replicationcontrollers/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ReplicationController +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified ReplicationController + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 201 - Created +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 201 - Created +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ReplicationController +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the ReplicationController +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified ReplicationController + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 201 - Created +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified ReplicationController + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 201 - Created +| xref:../workloads_apis/replicationcontroller-v1.adoc#replicationcontroller-v1[`ReplicationController`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/rest_api/workloads_apis/statefulset-apps-v1.adoc b/rest_api/workloads_apis/statefulset-apps-v1.adoc index 08d9b120bb36..9cf0930b38c8 100644 --- a/rest_api/workloads_apis/statefulset-apps-v1.adoc +++ b/rest_api/workloads_apis/statefulset-apps-v1.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="statefulset-apps-v1"] = StatefulSet [apps/v1] ifdef::product-title[] @@ -36,7 +38,7 @@ Type:: | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` -| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` @@ -48,7 +50,7 @@ Type:: | StatefulSetStatus represents the current state of a StatefulSet. |=== -..spec +=== .spec Description:: + -- @@ -86,7 +88,7 @@ Required:: | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. | `selector` -| xref:../objects/index.adoc#labelselector-meta-v1[`LabelSelector meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `serviceName` @@ -94,7 +96,7 @@ Required:: | serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. | `template` -| xref:../objects/index.adoc#podtemplatespec-core-v1[`PodTemplateSpec core/v1`] +| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. | `updateStrategy` @@ -102,11 +104,11 @@ Required:: | StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. | `volumeClaimTemplates` -| xref:../storage_apis/persistentvolumeclaim-core-v1.adoc#persistentvolumeclaim-core-v1[`array (PersistentVolumeClaim core/v1)`] +| xref:../storage_apis/persistentvolumeclaim-v1.adoc#persistentvolumeclaim-v1[`array (PersistentVolumeClaim)`] | volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. |=== -..spec.updateStrategy +=== .spec.updateStrategy Description:: + -- @@ -132,7 +134,7 @@ Type:: | Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. |=== -..spec.updateStrategy.rollingUpdate +=== .spec.updateStrategy.rollingUpdate Description:: + -- @@ -154,7 +156,7 @@ Type:: | Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. |=== -..status +=== .status Description:: + -- @@ -218,7 +220,7 @@ Required:: | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |=== -..status.conditions +=== .status.conditions Description:: + -- @@ -231,7 +233,7 @@ Type:: -..status.conditions[] +=== .status.conditions[] Description:: + -- @@ -252,7 +254,7 @@ Required:: | Property | Type | Description | `lastTransitionTime` -| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transitioned from one status to another. | `message` @@ -279,19 +281,21 @@ The following API endpoints are available: * `/apis/apps/v1/statefulsets` - `GET`: list or watch objects of kind StatefulSet +* `/apis/apps/v1/watch/statefulsets` +- `GET`: watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/statefulsets` - `DELETE`: delete collection of StatefulSet - `GET`: list or watch objects of kind StatefulSet - `POST`: create a StatefulSet +* `/apis/apps/v1/watch/namespaces/{namespace}/statefulsets` +- `GET`: watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}` - `DELETE`: delete a StatefulSet - `GET`: read the specified StatefulSet - `PATCH`: partially update the specified StatefulSet - `PUT`: replace the specified StatefulSet -* `/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale` -- `GET`: read scale of the specified StatefulSet -- `PATCH`: partially update scale of the specified StatefulSet -- `PUT`: replace scale of the specified StatefulSet +* `/apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}` +- `GET`: watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status` - `GET`: read status of the specified StatefulSet - `PATCH`: partially update status of the specified StatefulSet @@ -357,7 +361,74 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#statefulsetlist-apps-v1[`StatefulSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.StatefulSetList[`StatefulSetList`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/statefulsets + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -440,7 +511,7 @@ Defaults to unset |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -449,7 +520,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -506,7 +579,9 @@ Defaults to unset |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#statefulsetlist-apps-v1[`StatefulSetList apps/v1`] +| xref:../objects/index.adoc#io.k8s.api.apps.v1.StatefulSetList[`StatefulSetList`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -533,7 +608,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema | |=== @@ -542,7 +617,86 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 201 - Created +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 202 - Accepted +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/apps/v1/watch/namespaces/{namespace}/statefulsets + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -599,7 +753,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#deleteoptions-meta-v1[`DeleteOptions meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== @@ -608,7 +762,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#status-meta-v1[`Status meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 202 - Accepted +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -623,7 +781,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -653,7 +813,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -662,7 +822,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 201 - Created +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -689,7 +853,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema | |=== @@ -698,11 +862,15 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 201 - Created +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== -=== /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale +=== /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name} .Global path parameters [cols="1,1,2",options="header"] @@ -710,7 +878,7 @@ Description:: | Parameter | Type | Description | `name` | `string` -| name of the Scale +| name of the StatefulSet | `namespace` | `string` | object name and auth scope, such as for teams and projects @@ -720,99 +888,61 @@ Description:: [cols="1,1,2",options="header"] |=== | Parameter | Type | Description -| `pretty` +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` | `string` -| If 'true', then the output is pretty printed. -|=== - -HTTP method:: - `GET` - -Description:: - read scale of the specified StatefulSet - - -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -|=== - -HTTP method:: - `PATCH` - -Description:: - partially update scale of the specified StatefulSet +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` | `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` +| If 'true', then the output is pretty printed. +| `resourceVersion` | `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). -| `force` -| `boolean` -| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. -|=== +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] -| -|=== +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. -.HTTP responses -[cols="1,1",options="header"] -|=== -| HTTP code | Reponse body -| 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: - `PUT` + `GET` Description:: - replace scale of the specified StatefulSet - - -.Query parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `dryRun` -| `string` -| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed -| `fieldManager` -| `string` -| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. -|=== + watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. -.Body parameters -[cols="1,1,2",options="header"] -|=== -| Parameter | Type | Description -| `body` -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] -| -|=== .HTTP responses [cols="1,1",options="header"] |=== | HTTP code | Reponse body | 200 - OK -| xref:../objects/index.adoc#scale-autoscaling-v1[`Scale autoscaling/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema +| 401 - Unauthorized +| Empty |=== @@ -851,7 +981,9 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -881,7 +1013,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../objects/index.adoc#patch-meta-v1[`Patch meta/v1`] +| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== @@ -890,7 +1022,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 201 - Created +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== HTTP method:: @@ -917,7 +1053,7 @@ Description:: |=== | Parameter | Type | Description | `body` -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema | |=== @@ -926,7 +1062,11 @@ Description:: |=== | HTTP code | Reponse body | 200 - OK -| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet apps/v1`] +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 201 - Created +| xref:../workloads_apis/statefulset-apps-v1.adoc#statefulset-apps-v1[`StatefulSet`] schema +| 401 - Unauthorized +| Empty |=== diff --git a/rest_api/workloads_apis/workloads-apis-index.adoc b/rest_api/workloads_apis/workloads-apis-index.adoc index 9d8f9e1ef4d2..877b33a23bbd 100644 --- a/rest_api/workloads_apis/workloads-apis-index.adoc +++ b/rest_api/workloads_apis/workloads-apis-index.adoc @@ -1,3 +1,5 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY [id="workloads-apis"] = Workloads APIs ifdef::product-title[] @@ -27,6 +29,28 @@ Description:: Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the Pod which executed the build. -- +Type:: + `object` + +== BuildLog [build.openshift.io/v1] + +Description:: ++ +-- +BuildLog is the (unused) resource associated with the build log redirector +-- + +Type:: + `object` + +== BuildRequest [build.openshift.io/v1] + +Description:: ++ +-- +BuildRequest is the resource used to pass parameters to build generator +-- + Type:: `object` @@ -73,6 +97,39 @@ Deployment Configs define the template for a pod and manages deploying new image A deployment is "triggered" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The "strategy" determines how the deployment is carried out and may be changed at any time. The `latestVersion` field is updated when a new deployment is triggered by any means. -- +Type:: + `object` + +== DeploymentConfigRollback [apps.openshift.io/v1] + +Description:: ++ +-- +DeploymentConfigRollback provides the input to rollback generation. +-- + +Type:: + `object` + +== DeploymentLog [apps.openshift.io/v1] + +Description:: ++ +-- +DeploymentLog represents the logs for a deployment +-- + +Type:: + `object` + +== DeploymentRequest [apps.openshift.io/v1] + +Description:: ++ +-- +DeploymentRequest is a request to a deployment config for a new deployment. +-- + Type:: `object` @@ -87,7 +144,7 @@ Job represents the configuration of a single job. Type:: `object` -== Pod [core/v1] +== Pod [v1] Description:: + @@ -98,7 +155,7 @@ Pod is a collection of containers that can run on a host. This resource is creat Type:: `object` -== ReplicationController [core/v1] +== ReplicationController [v1] Description:: + @@ -109,7 +166,7 @@ ReplicationController represents the configuration of a replication controller. Type:: `object` -== PersistentVolume [core/v1] +== PersistentVolume [v1] Description:: + diff --git a/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc index d8e989108770..9b8e65ce571c 100644 --- a/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc +++ b/virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc @@ -33,4 +33,4 @@ include::modules/virt-creating-a-service-from-a-virtual-machine.adoc[leveloffset .Additional resources * xref:../../../networking/configuring_ingress_cluster_traffic/configuring-externalip.adoc#configuring-externalip[Configuring external IPs] -* xref:../../../rest_api/network_apis/service-core-v1.adoc#service-core-v1[Service API specification] +* xref:../../../rest_api/network_apis/service-v1.adoc#service-v1[Service API specification]