OpenFGA v0.1.6 is out!

[rhamzeh]

The v0.1.6 release of OpenFGA is now out!

If you are running through docker, you can make sure you have the latest release by running:

docker pull openfga/openfga

Or if you are pinning your releases, make sure to set your pinned version to openfga/openfga:v0.1.6

Be sure to read the Changed section below to ensure that you have configuration set up properly.

Note: v0.1.6 is the same release as v0.1.5, but with some fixes that prevented the built docker container from running.

Changes in this release

Added

• Support for defining server configuration in config.yaml, CLI flags, or env variables (chore: get config config.yaml file and use viper openfga#63 feat: add basic CLI flags to the run command openfga#92 feat: wire up support for env variables openfga#100)

  This release introduces multiple ways to support a variety of server configuration strategies. You can configure the server with CLI flags, env variables, or a config.yaml file.

  Server config will be loaded in the following order of precedence:

  • CLI flags (e.g. --datastore-engine)
  • env variables (e.g. OPENFGA_DATASTORE_ENGINE)
  • config.yaml

  If a config.yaml file is provided, the OpenFGA server will look for it in "/etc/openfga", "$HOME/.openfga", or "." (the current working directory), in that order.

  Read more on how to configure the OpenFGA server here.

• Support for grpc health checks (feat: add grpc health checks and wire it up with /healthz openfga#86)

  This release introduces support for the GRPC Health Checking Protocol. The server's health can be checked with the grpc or HTTP health check endpoints (the /healthz endpoint is just a proxy to the grpc health check RPC).

  For example,

  grpcurl -plaintext \
    -d '{"service":"openfga.v1.OpenFGAService"}' \
    localhost:8081 grpc.health.v1.Health/Check
  

  or, if the HTTP server is enabled, with the /healthz endpoint:

  curl --request GET -d '{"service":"openfga.v1.OpenFGAService"}' http://localhost:8080/healthz
  

• Profiling support (pprof) (feat: add configurable pprof profiling support openfga#111)

  You can now profile the OpenFGA server while it's running using the pprof profiler. To enable the pprof profiler set profiler.enabled=true. It is served on the /debug/pprof endpoint and port 3001 by default.

• Configuration to enable/disable the HTTP server (feat: allow the HTTP gateway server to be enabled/disabled openfga#84)

  You can now enable/disable the HTTP server by setting http.enabled=true/false. It is enabled by default.

Changed

• Env variables have a new mappings.

  Please refer to the .config-schema.json file for a description of the new configurations or openfga run -h for the CLI flags. Env variables are mapped by prefixing OPENFGA and converting dot notation into underscores (e.g. datastore.uri becomes OPENFGA_DATASTORE_URI).

Fixed

• goroutine leaks in Check resolution. (fix: goroutine leak openfga#113)
• v0.1.6 fixes an issue with embedded assets preventing the released docker image from being run. (fix: embed assets using go:embed openfga#129)