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 architecture and persistence #6250

Merged
merged 5 commits into from
Jul 31, 2023

Conversation

BeryJu
Copy link
Member

@BeryJu BeryJu commented Jul 13, 2023

Details

closes #3693
closes #4092
closes #4661

Changes

New Features

  • Adds feature which does x, y, and z.

Breaking Changes

  • Adds breaking change which causes <issue>.

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)
  • The translation files have been updated (make i18n-extract)

If applicable

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

@BeryJu BeryJu requested a review from tanberry July 13, 2023 11:56
@BeryJu BeryJu requested a review from a team as a code owner July 13, 2023 11:56
@netlify
Copy link

netlify bot commented Jul 13, 2023

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit c6a3e7b
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/64c77af4051bba000808ed4d

@netlify
Copy link

netlify bot commented Jul 13, 2023

Deploy Preview for authentik ready!

Name Link
🔨 Latest commit c6a3e7b
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/64c77af4dc8d130008d60472
😎 Deploy Preview https://deploy-preview-6250--authentik.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.

@codecov
Copy link

codecov bot commented Jul 13, 2023

Codecov Report

Patch coverage has no change and project coverage change: -40.15% ⚠️

Comparison is base (b0bce60) 92.72% compared to head (c6a3e7b) 52.56%.
Report is 133 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #6250       +/-   ##
===========================================
- Coverage   92.72%   52.56%   -40.15%     
===========================================
  Files         551      561       +10     
  Lines       26593    27053      +460     
===========================================
- Hits        24655    14217    -10438     
- Misses       1938    12836    +10898     
Flag Coverage Δ
e2e 50.75% <ø> (-0.80%) ⬇️
integration 26.51% <ø> (+0.15%) ⬆️
unit ?

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

see 391 files with indirect coverage changes

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

@github-actions
Copy link
Contributor

github-actions bot commented Jul 13, 2023

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-website-docs-add-architecture-persistence-1689345544-26cf948
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-website-docs-add-architecture-persistence-1689345544-26cf948-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
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-website-docs-add-architecture-persistence-1689345544-26cf948

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-website-docs-add-architecture-persistence-1689345544-26cf948-arm64

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

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu force-pushed the website/docs/add-architecture-persistence branch from 55ef5f4 to 1958698 Compare July 13, 2023 13:26

##### Persistence

- `/var/lib/postgresql/data` is used to store the PostgreSQL database
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `/var/lib/postgresql/data` is used to store the PostgreSQL database
- The `/var/lib/postgresql/data` directory is used to store the PostgreSQL database.


##### Persistence

- `/data` is used to store the Redis data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `/data` is used to store the Redis data
- the `/data` directory is used to store the Redis data.

BeryJu and others added 4 commits July 14, 2023 12:31
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu merged commit 33e7903 into main Jul 31, 2023
@BeryJu BeryJu deleted the website/docs/add-architecture-persistence branch July 31, 2023 09:21
kensternberg-authentik added a commit that referenced this pull request Aug 7, 2023
* main:
  blueprints: prevent duplicate password stage in default flow when using combined identification stage (#6432)
  website/integrations: cite better (#6431)
  root: add generated Source docs (#5323)
  website/docs: add architecture and persistence (#6250)
  core: bump paramiko from 3.2.0 to 3.3.1 (#6428)
  website: fix sidebar sizing (#6430)
  ci: update dependabot labels (#6423)
  website: fix sidebar layout (#6421)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants