Auth Module

Auth Module provides authentication and access management for SIGHUP Distribution (SD).

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

Overview

Auth Module 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

The following packages are included in Auth Module:

Package	Version	Description
Pomerium	v0.32.7	Identity-aware proxy that enables secure access to internal applications.
Dex	v2.45.1	Dex is a Federated OpenID Connect Provider.
Gangplank	v1.2.1	Enable authentication flows via OIDC for a Kubernetes cluster.

Click on each package to see its full documentation.

Compatibility

Kubernetes Version	Compatibility	Notes
1.29.x	:white_check_mark:	No known issues.
1.30.x	:white_check_mark:	No known issues.
1.31.x	:white_check_mark:	No known issues.
1.32.x	:white_check_mark:	No known issues.
1.33.x	:white_check_mark:	No known issues.
1.34.x	:white_check_mark:	No known issues.
1.35.x	:white_check_mark:	No known issues.

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

Usage

Auth Module is part of SIGHUP Distribution (SD) and is deployed automatically by furyctl when you create or update a cluster. You don't need to download, vendor or install its packages manually.

Configuration

You configure the module under spec.distribution.modules.auth in your furyctl.yaml. The provider.type field selects how access to the cluster's internal applications is protected: none (no added authentication, the default), basicAuth, or sso (Pomerium + Dex). The other fields are optional and fall back to sensible defaults.

apiVersion: kfd.sighup.io/v1alpha2
kind: KFDDistribution
spec:
  distribution:
    modules:
      auth:
        baseDomain: example.dev
        provider:
          type: sso
        dex:
          connectors:
            - type: ldap
              id: ldap
              name: LDAP
              # connector-specific configuration
        pomerium: {}

See the configuration reference for your cluster kind for the full list of available options: EKSCluster, KFDDistribution or OnPremises.

To install SD from scratch, follow the Getting started guide.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

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

License

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