Liking cljdoc? Tell your friends :D

monkey.ci.build.api-server

Functions for setting up a build script API. The build runner starts its own API server, which is only accessible by the build script and any containers it starts. This is for security reasons, since the build script is untrusted code. Restricting access to the API server is done on infra level, by setting up network security rules. Piping all traffic through the build runner also ensures that the global API will not be overloaded by malfunctioning (or misbehaving) builds.

Functions for setting up a build script API.  The build runner starts its own
API server, which is only accessible by the build script and any containers it
starts.  This is for security reasons, since the build script is untrusted code.
Restricting access to the API server is done on infra level, by setting up network
security rules.  Piping all traffic through the build runner also ensures that
the global API will not be overloaded by malfunctioning (or misbehaving) builds.
raw docstring

api-clientclj

source

contextclj

source

download-artifactclj

(download-artifact req)

Downloads an artifact. The body contains the artifact as a stream.

Downloads an artifact.  The body contains the artifact as a stream.
sourceraw docstring

download-cacheclj

(download-cache req)
source

download-workspaceclj

(download-workspace req)
source

ednclj

source

generate-tokenclj

(generate-token)

Generates a new API security token. This token can be set in the API server and should be passed on to the build script.

Generates a new API security token.  This token can be set in the API server
and should be passed on to the build script.
sourceraw docstring

get-ip-addrclj

(get-ip-addr)

Determines the ip address of this VM

Determines the ip address of this VM
sourceraw docstring

get-paramsclj

source

make-appclj

(make-app opts)
source

make-routerclj

(make-router opts)
(make-router opts routes)
source

post-eventsclj

(post-events req)
source

repo-idclj

source

req->apiclj

source

req->artifactsclj

source

req->buildclj

Gets current build configuration from the request

Gets current build configuration from the request
sourceraw docstring

req->cacheclj

source

req->ctxclj

(req->ctx req)

Gets the config map from the request

Gets the config map from the request
sourceraw docstring

req->storageclj

source

req->workspaceclj

source

routesclj

source

rt->api-server-configclj

(rt->api-server-config rt)

Creates a config map for the api server from the given runtime

Creates a config map for the api server from the given runtime
sourceraw docstring

security-middlewareclj

(security-middleware handler token)

Middleware that checks if the authorization header matches the specified token

Middleware that checks if the authorization header matches the specified token
sourceraw docstring

start-serverclj

(start-server {:keys [port] :or {port 0} :as conf})

Starts a build API server with a randomly generated token. Returns the server and token.

Starts a build API server with a randomly generated token.  Returns the server
and token.
sourceraw docstring

upload-artifactclj

(upload-artifact req)

Uploads a new artifact. The body should contain the file contents.

Uploads a new artifact.  The body should contain the file contents.
sourceraw docstring

upload-cacheclj

(upload-cache req)
source

with-buildclj

(with-build conf b)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close