This is a cache of https://docs.okd.io/4.13/rest_api/workloads_apis/buildlog-build-openshift-io-v1.html. It is a snapshot of the page at 2024-11-24T01:28:41.124+0000.
BuildLog [build.openshift.io/v1] - Workloads <strong>api</strong>s | <strong>api</strong> reference | OKD 4.13
  1. Documentation
×

BuildLog [build.openshift.io/v1]

Description

BuildLog is the (unused) resource associated with the build log redirector

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Specification

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

Table 1. Global path parameters
Parameter Type Description

name

string

name of the BuildLog

namespace

string

object name and auth scope, such as for teams and projects
Table 2. Global query parameters
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

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

BuildLog schema

401 - Unauthorized

Empty