Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: add info about invalidation flow, default flows in general #11800

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Oct 24, 2024

DRAFT

This PR adds a new section about default flows, and commonly used flows, and the new invalidation flow.

TODO: add description for remaining flows in the list.

  • The documentation has been updated
  • The documentation has been formatted (make website)

@tanberry tanberry requested a review from a team as a code owner October 24, 2024 22:36
@tanberry tanberry marked this pull request as draft October 24, 2024 22:36
Copy link

netlify bot commented Oct 24, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 27ed3cf
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/671acbe66b50e80008758417

Copy link

netlify bot commented Oct 24, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 27ed3cf
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/671acbe6aff1070008e2c5d4
😎 Deploy Preview https://deploy-preview-11800--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.55%. Comparing base (3fc0904) to head (27ed3cf).
Report is 2 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11800      +/-   ##
==========================================
- Coverage   92.56%   92.55%   -0.02%     
==========================================
  Files         760      760              
  Lines       37732    37736       +4     
==========================================
- Hits        34926    34925       -1     
- Misses       2806     2811       +5     
Flag Coverage Δ
e2e 49.17% <ø> (-0.07%) ⬇️
integration 24.94% <ø> (-0.01%) ⬇️
unit 90.12% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-27ed3cf3591bf1e4bc4bc14a60faa00999ffdff3
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-27ed3cf3591bf1e4bc4bc14a60faa00999ffdff3-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-27ed3cf3591bf1e4bc4bc14a60faa00999ffdff3

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-27ed3cf3591bf1e4bc4bc14a60faa00999ffdff3-arm64

Afterwards, run the upgrade commands from the latest release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant