radix-log-api

README

radix-log-api

The Radix Log API gives access to container logs from Azure Log Analytics Workspaces for applications hosted in Radix.

Configuration

Command line arguments

Name	Type	Required	Description	Default
host	string	No	Host name or IP for the server	""
port	string	No	Port that the server listens to	"8000"
auth-issuer	string	Yes	The expected issuer (iss claim) for JWT used as bearer token in authorization header for incoming requests	""
auth-audience	string	Yes	The expected audience (aud) for JWT used as bearer token in authorization header for incoming requests	""
log-analytics-workspace-id	string	Yes	The workspace ID for the Azure Log Analytic Workspace to collect container logs from	""
log-analytics-log-table	string	No	The log analytics table to read logs from. Valid values ContainerLog, ContainerLogV2 or Both	Both
radix-api-host	string	Yes	FQDN to the Radix API server	""
radix-api-path	string	No	Base path for Radix API	"/api/v1"
radix-api-scheme	string	No	The Radix API HTTP scheme (https or http)	"https"

Every command line argument can be specified as an environment variable by prefixing it with LOG_API_, capitalizing it, and replicaing hyphens (-) with underscores (_), e.g. auth-issuer becomes LOG_API_AUTH_ISSUER.

Developing

You need Go installed. Make sure GOPATH and GOROOT are properly set up.

Also needed:

• gomock (go install github.com/golang/mock/mockgen@v1.6.0)

Clone the repo into your GOPATH and run go mod download.

Contribution

Want to contribute? Follow these contributing guidlines

Code Generation

Swagger docs are generated using https://github.com/swaggo/swag. The Declarative Comments Format describes how to configure the swagger spec. Run make swagger if changes are made to the swagger definition in code files.

Mocks used in tests are generated with gomock. You need to regenerate mocks by running make mocks if you make changes to any of the interface types used by the application.

There is one radixconfig file per cluster. File radixconfig.yaml.tpl is the template used to generate these files. Run make radixconfigs to regenerate if changes are made to the template.

Run make generate to run all code generations described above.

The Radix API Client is generated from the swagger.json hosted on https://api.radix.equinor.com/swaggerui/swagger.json. Run make radixapiclient on regular intervals to update the client code with changes made to the source. This code generation is NOT included in make generate.

Running locally

The following envirnoment variables are needed.
Copy file .env.template to .env

• LOG_API_AUTH_ISSUER
• LOG_API_AUTH_AUDIENCE
• LOG_API_LOG_ANALYTICS_WORKSPACE_ID
• LOG_API_RADIX_API_HOST

Deployment

Radix Log API follows the standard procedure defined in how we work.

Radix Log API is installed as a Radix application in script when setting up a cluster.

---

Security notification