Awesome

Kubernetes Fury Auth provides Authentication Management for Kubernetes Fury Distribution (KFD).

If you are new to KFD please refer to the official documentation on how to get started with the distribution.

Overview

Kubernetes Fury Auth uses CNCF recommended, Cloud Native projects, such as the Dex identity provider, and Pomerium as an identity-aware proxy to enable secure access to internal applications.

Packages

Kubernetes Fury Auth provides the following packages:

Compatibility

Check the compatibility matrix for additional information on previous releases of the modules.

Usage

[!NOTE] Instructions below are for deploying the module using furyctl legacy, that required manual intervention.

Latest versions of furyctl automate the whole process and it is recommended to use the latest version of furyctl instead.

Prerequisites

Deployment with legacy furyctl

1. List the packages you want to deploy and their version in a Furyfile.yml:

versions:
  auth: "v0.3.0"
bases:
  - name: auth/pomerium
  - name: auth/dex
  - name: auth/gangplank

See furyctl documentation for additional details about Furyfile.yml format.

2. Execute furyctl vendor -H to download the packages

3. Inspect the download packages under ./vendor/katalog/auth/.

4. Define a kustomization.yaml that includes the ./vendor/katalog/auth directory as a resource.

resources:
  - ./vendor/katalog/auth/pomerium
  - ./vendor/katalog/auth/dex
  - ./vendor/katalog/auth/gangplank

5. Create the configuration file for Dex (here's an LDAP-based example) and add it as a secret to the kustomization.yaml file, like this:

secretGenerator:
  - name: dex
    namespace: kube-system
    files:
      - config.yml=./secrets/dex/config.yml

ℹ️ read more on Dex's readme.

⛔️ Before proceeding, follow the instructions in Pomerium's package readme and Gangplank's readme to configure them.

6. Finally, to deploy the module to your cluster, execute:

kustomize build . | kubectl apply -f -

Monitoring

KFD Auth module integrates out-of-the-box with KFD's Monitoring module. Providing metrics and dashboards to visualize the status of its components.

In particular:

• Dex exposes standard Go adapter metrics, the metrics are automatically scrapped by Prometheus when using KFD Monitoring module but there are no Grafana dashboards nor alerts defined.
• Pomerium exposes several metrics about Pomerium itself and its underlying envoy proxy. Metrics are scrapped automatically by Prometheus and 2 Grafana dashboards are available with the pomerium tag when using KFD Monitoring module. Here are some screenshots:

<a href="docs/images/screenshots/pomerium-dashboard.png"><img src="docs/images/screenshots/pomerium-dashboard.png" width="250"/></a> <a href="docs/images/screenshots/pomerium-envoy-dashboard.png"><img src="docs/images/screenshots/pomerium-envoy-dashboard.png" width="250"/></a>

Screenshots

• Dex Login:

<a href="docs/images/screenshots/dex.png"><img src="docs/images/screenshots/dex.png" width="250"/></a>

• Pomerium 403 not authorized error screen:

<a href="docs/images/screenshots/pomerium-403.png"><img src="docs/images/screenshots/pomerium-403.png" width="250"/></a>

• Pomerium user profile screen:

<a href="docs/images/screenshots/pomerium-userprofile.png"><img src="docs/images/screenshots/pomerium-userprofile.png" width="250"/></a>

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problems with the module, please open a new issue.

License

This module is open-source and it's released under the following LICENSE