Skip to content

Add authentication configurations to the repository to support transparency and reuseΒ #19

@janhalen

Description

@janhalen

πŸ“¦ Repository Checklist for Authentik PoC Deployment

To ensure the PoC is:

  • βœ… Transparent and reusable
  • πŸ” Easily reproducible across environments
  • ⚠️ Minimizing manual, error-prone configuration

Please include declarative configurations for the following:


πŸ“ File Structure & Deployment Manifests

  • Create a dedicated folder for the PoC setup (e.g. /configs/authorization)
  • Add all deployment manifests:
    • authentik-deploy.yaml
    • Ingress configuration
    • Persistent volume claims
    • Secrets templates (e.g. secrets-template.yaml)

βš™οΈ Configuration Files

  • Include relevant Authentik configuration files:
    • Initial user setup
    • OIDC provider settings
    • Application definitions
    • Access policies

🧩 Authentik Blueprints (Recommended)

To support declarative setup and reduce manual configuration:

  • Add blueprints for:

    • Identity Provider (IDP) sources (e.g. OIDC, LDAP, SAML)
    • Claim mappings and scopes
    • User/group assignments
    • Application definitions and access policies
  • Place blueprints in /config/authentik

  • Name files descriptively (e.g. oidc-idp-source.yaml, claim-mapping-basic.yaml)


πŸ“„ Documentation

  • Add a README.md inside /authentik-config explaining:
    • Purpose of each file
    • Step-by-step deployment instructions
    • Required dependencies or assumptions
    • How to verify that Authentik is running correctly

Its fine to link to external doc sources if they serve the purpose for reproducibility.


πŸ”„ Reusability & Handover Readiness

  • Ensure values are templated
  • Avoid hardcoded values unless necessary; document them clearly
  • Confirm that another supplier can reproduce the setup without undocumented steps

βœ… Final Review

  • Test the deployment from scratch using only the repo contents
  • Confirm that documentation is clear, complete, and up to date

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions