fbladilo/forklift-must-gather-api

Forklift must-gather API service

This repo provides HTTP API to allow trigger OpenShift must-gather (full or targeted) and provide output archive again via HTTP.

Usage

Get it and run

$ go get github.com/konveyor/forklift-must-gather-api
$ cd ~/go/src/github.com/konveyor/forklift-must-gather-api
$ go run pkg/must-gather-api.go

API examples

Start must-gather execution

$ curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" -d '{"image": "quay.io/konveyor/forklift-must-gather", "timeout": "15m"}' http://localhost:8080/must-gather

Get must-gather execution (status field values: new, inprogress, completed, error)

$ curl -H "Authorization: Bearer <TOKEN>" http://localhost:8080/must-gather/15

Download must-gather archive (available only if must-gather execution status == "completed")

$ curl -H "Authorization: Bearer <TOKEN>" -OJ http://localhost:8080/must-gather/15/data

List all must-gather executions

$ curl -H "Authorization: Bearer <TOKEN>" http://localhost:8080/must-gather

Example of must-gather JSON object returned by API

{
  "id": 15,
  "created-at": "2021-06-30T15:19:17.514594773+02:00",
  "updated-at": "2021-06-30T15:23:05.415732774+02:00",
  "custom-name": "",
  "status": "completed",
  "image": "quay.io/konveyor/forklift-must-gather",
  "image-stream": "",
  "node-name": "",
  "command": "",
  "source-dir": "",
  "timeout": "30m",
  "server": "",
  "archive-size": 95334,
  "exec-output": "[must-gather      ] OUT Using must-gather plug-in image: quay.io/maufart/forklift-must-gather\n[must-gather      ]..."
}

Available API parameters

Parameters below are passed from JSON API to must-gather execution.

API param name	Description	Example
image	must-gather image name	quay.io/maufart/forklift-must-gather
image-stream	must-gather image with tags	quay.io/maufart/forklift-must-gather:custom-tag
node-name	node name to execute must-gather pod on	cluster-test4-fcjdb-master-1
command	custom command to be executed	PLAN=plan1 /usr/bin/targeted
timeout	timeout for must-gather execution	60m
source-dir	must-gather pod directory to take data from	/var/local/something
server	k8s API server which should be used	(taken from KUBECONFIG by default)
custom-name	custom ID to query the must-gather execution without remembering its ID	forklift-plan1

All params are optional. Empty POST request will run must-gather with default options configured on server side (see below).

Authentication

For interaction with the API it is needed to be a cluster-admin. It is required to pass a Bearer token in Authorization HTTP header, e.g. Authorization: Bearer sha256~ML7q_m_kjOzfk...).

The token can be printed in command line by $ oc whoami -t command or captured from HTTP headers in OpenShift web UI requests.

Configuration

The wrapper default options can be adjusted by OS Environment variables.

Option	Default value	Description
PORT	8080	Port where the wrapper listens on
DB_PATH	./gatherings.db	Local storage for must-gather executions records, can be ephemeral or just in memory file::memory:?cache=shared
MUST_GATHER_IMAGE	quay.io/konveyor/forklift-must-gather	Image name to be used if it was not specified in API call
TIMEOUT	20m	Timeout for must-gather execution
ARCHIVE_FILENAME	must-gather.tar.gz	Archive filename to be searched in must-gather execution directory to be provided to user as the result archive
CLEANUP_MAX_AGE	-1	Maximum age of must-gather executions kept available in the wrapper, -1 disables the deletion, e.g. 24h
DEBUG	(not set)	Set to enable debugging output when running in cluster, e.g. true
USE_KUBECONFIG	(not set)	Set to enable using local kubeconfig file, e.g. true

Notes

Checkout doc directory for more information.

Initial development progress

• prepare HTTP endpoints in gin-gonic
• prepare database/storage for gatherings metadata
• prepare image build scripts
• implement create / get / list gatherings (into db)
• implement raw single must-gather execution based on gathering db record
• implement all needed oc adm must-gather options support
• add ENV variables-driven default must-gather options values
• not needed now: handle async/not-blocking gathering with sane limits (e.g. max 10 simul.gatherings)
• prepare serving of gathered archive
• add periodical obsolete data cleanup
• add ocp auth for gin-gonic by bearer token
• not used:use passed admin token from operator to exec must-gather (from operator)
• basic tests
• document API usage