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 source property mappings, rework provider property mappings #10652

Merged
merged 21 commits into from
Aug 7, 2024

Conversation

rissson
Copy link
Member

@rissson rissson commented Jul 26, 2024

Details

Docs for #8771 and #10650 and #10772

Needs #10810


If applicable

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

…mappings

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson self-assigned this Jul 26, 2024
@rissson rissson requested a review from a team as a code owner July 26, 2024 16:06
Copy link

netlify bot commented Jul 26, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit be3ffeb
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66b3c7072f090a000855dd42
😎 Deploy Preview https://deploy-preview-10652--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

netlify bot commented Jul 26, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit be3ffeb
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/66b3c707b99eb800082765a8

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson requested a review from a team as a code owner July 26, 2024 16:08
rissson added 2 commits July 26, 2024 18:09
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.75%. Comparing base (9343e34) to head (be3ffeb).

❗ There is a different number of reports uploaded between BASE (9343e34) and HEAD (be3ffeb). Click for more details.

HEAD has 2 uploads less than BASE
Flag BASE (9343e34) HEAD (be3ffeb)
unit 2 0
Additional details and impacted files
@@             Coverage Diff             @@
##             main   #10652       +/-   ##
===========================================
- Coverage   92.62%   50.75%   -41.88%     
===========================================
  Files         734      732        -2     
  Lines       36039    35776      -263     
===========================================
- Hits        33381    18157    -15224     
- Misses       2658    17619    +14961     
Flag Coverage Δ
e2e 49.41% <ø> (ø)
integration 25.18% <ø> (ø)
unit ?

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

github-actions bot commented Jul 26, 2024

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-be3ffeb7e5d2e3825048a20c5fafba3bccd7f2b7
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-be3ffeb7e5d2e3825048a20c5fafba3bccd7f2b7-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-be3ffeb7e5d2e3825048a20c5fafba3bccd7f2b7

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-be3ffeb7e5d2e3825048a20c5fafba3bccd7f2b7-arm64

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

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Awesome docs! Thanks so much @rissson for doing all of these. It's a lot and it looks like you found every file that needed to be created or updated! I'm really grateful that you did these docs, not me, haha.

Sorry for the gazillion tiny edits about capitalization... our Style Guide is only recently mature enough to cover most things.

The two biggest take-aways are:

  • Now that we have two types of property mappings (those we use with providers and those we use with sources) and expression-based mappings for both providers and sources, we just need to make sure that the titles are very very explicit.
  • The original property mappings page should just be deleted. It only serves as a navigation aid now, and that benefit is outweighed by the disadvantage of having three topics about property mappings. ;-)

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson
Copy link
Member Author

rissson commented Jul 29, 2024

Ugh, a bunch of anchors are now broken due to the subtitle changes

@rissson
Copy link
Member Author

rissson commented Jul 29, 2024

Sorry for the gazillion tiny edits about capitalization... our Style Guide is only recently mature enough to cover most things.

No worries :D

The original property mappings page should just be deleted. It only serves as a navigation aid now, and that benefit is outweighed by the disadvantage of having three topics about property mappings.

Agreed. I didn't know what you wanted to do with it, so I left it as a stub to make it easier to find from the navigation bar (as it's also an item in the navigation bar in the product), but we can remove it.

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Copy link
Contributor

@kensternberg-authentik kensternberg-authentik left a comment

Choose a reason for hiding this comment

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

Still that TODO, and I found one typo.

rissson added 4 commits July 29, 2024 19:31
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson requested a review from tanberry July 29, 2024 17:38
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson requested a review from a team as a code owner July 29, 2024 18:01
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
rissson added 2 commits July 29, 2024 21:31
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
rissson and others added 3 commits August 1, 2024 17:02
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Awesome docs, thanks so much!

@rissson rissson mentioned this pull request Aug 5, 2024
6 tasks
rissson added 2 commits August 5, 2024 15:44
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
rissson added 2 commits August 7, 2024 21:09
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
@rissson rissson enabled auto-merge (squash) August 7, 2024 19:18
@rissson rissson disabled auto-merge August 7, 2024 19:19
@rissson rissson enabled auto-merge (squash) August 7, 2024 19:19
@rissson rissson merged commit 322ae4c into main Aug 7, 2024
68 of 69 checks passed
@rissson rissson deleted the sources-property-mappings-docs branch August 7, 2024 19:30
kensternberg-authentik added a commit that referenced this pull request Aug 8, 2024
* main: (25 commits)
  website/docs: add link from Install docs to Enterprise docs (#10827)
  website/docs: new upgrade page (#10742)
  stages/authenticator: actually update last_used (#10813)
  sources/ldap: Add enabled filter for ldap_password_validate signal (#10823)
  web: bump API Client version (#10821)
  sources/plex: add property mappings (#10772)
  core: bump goauthentik.io/api/v3 from 3.2024063.2 to 3.2024063.5 (#10817)
  web: bump the wdio group across 2 directories with 4 updates (#10818)
  web: bump chromedriver from 127.0.1 to 127.0.2 in /tests/wdio (#10819)
  web: update to ESLint 9 (#10812)
  website/docs: add source property mappings, rework provider property mappings (#10652)
  web/admin: refactor property mappings forms (#10810)
  web: bump API Client version (#10811)
  sources/saml: Basic support for EncryptedAssertion element. (#10099)
  web: bump API Client version (#10809)
  sources: add property mappings for all oauth and saml sources (#8771)
  web: bump API Client version (#10808)
  stages/authenticator: add created, last_updated and last_used metadata (#10636)
  providers/proxy: avoid erroring on logout with session_id is None (#9119)
  core: bump google-api-python-client from 2.139.0 to 2.140.0 (#10802)
  ...
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.

4 participants