Skip to content
AthenZPublic

About

Garm is kubernetes authorization webhook (SubjectAccessReview API) server for Athenz

Topics

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

5 watching

Forks

Repository files navigation

Garm

License: Apache GitHub release (latest by date) Docker Image Version (tag latest) Go Report Card GoDoc Contributor Covenant

logo

What is Garm

concept

Garm implements the Kubernetes authorization webhook interface to provide access control on your K8s resources with Athenz RBAC policy. It allows flexible resource mapping from K8s resources to Athenz ones, mutli-tenancy, and black/white list.

By default, Garm replies the native Kubernetes authentication for authorization. However, it also supports the Kubernetes authentication webhook. Using the authentication hook requires Athenz to be able to sign tokens for users.

Requires go 1.26.9 or later.

Use Case

Authorization

use case

  1. K8s webhook request (SubjectAccessReview) (Webhook Mode - Kubernetes)
    • the K8s API server wants to know if the user is allowed to do the requested action
  2. Athenz RBAC request (Athenz)
    • Athenz server contains the user authorization information for access control
    • ask Athenz server is the user action is allowed based on pre-configured policy

Garm convert the K8s request to Athenz request based on the mapping rules in config.yaml (example).

P.S. It is just a sample deployment solution above. Garm can work on any environment as long as it can access both the API server and the Athenz server.

Docker

docker pull docker.io/athenz/garm

Usage

Development

Use the Go version declared in go.mod and golangci-lint v2.15.0. Run the Go checks from the repository root:

make lint
make test

make coverage runs the race-enabled tests and writes coverage.out and coverage.html without changing the module files.

With Node.js and npm installed, run the same Markdown checks as CI:

npm exec --yes --package=markdownlint-cli2@0.23.2 -- markdownlint-cli2 README.md 'docs/**/*.md'

About releases

  • Releases
    • GitHub release (latest by date)
    • Docker Image Version (tag latest)

About

Garm is kubernetes authorization webhook (SubjectAccessReview API) server for Athenz

Topics

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages