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: new PR for the Entra provider docs (ignore old one) #9741

Merged
merged 3 commits into from
May 16, 2024

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented May 15, 2024

This PR adds three new pages, for the new Entra ID provider, and adds Entra to the sidebar.js file.

Ignore PR #9687 it was too stale and got too messy when trying to rebase.

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

@tanberry tanberry requested a review from a team as a code owner May 15, 2024 15:15
Copy link

netlify bot commented May 15, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit d65f872
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66466e70eda6a300081166df
😎 Deploy Preview https://deploy-preview-9741--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 May 15, 2024

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit d65f872
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/66466e70af92290008b1b4d7
😎 Deploy Preview https://deploy-preview-9741--authentik-storybook.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 May 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.39%. Comparing base (9dc813d) to head (d65f872).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9741   +/-   ##
=======================================
  Coverage   92.39%   92.39%           
=======================================
  Files         704      704           
  Lines       34403    34403           
=======================================
+ Hits        31785    31786    +1     
+ Misses       2618     2617    -1     
Flag Coverage Δ
e2e 49.65% <ø> (-0.01%) ⬇️
integration 25.36% <ø> (ø)
unit 89.82% <ø> (-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-ghcr.io/goauthentik/dev-server:gh-df8ad1b09930d6f3d76c17b8a415768499d06b3d
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-ghcr.io/goauthentik/dev-server:gh-df8ad1b09930d6f3d76c17b8a415768499d06b3d-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-ghcr.io/goauthentik/dev-server:gh-df8ad1b09930d6f3d76c17b8a415768499d06b3d

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-ghcr.io/goauthentik/dev-server:gh-df8ad1b09930d6f3d76c17b8a415768499d06b3d-arm64

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

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.

Found some minor typos.

website/docs/providers/entra/add-entra-provider.md Outdated Show resolved Hide resolved
website/docs/providers/entra/add-entra-provider.md Outdated Show resolved Hide resolved

A _direct sync_ happens when a user or group is created, updated or deleted in authentik, or when a user is added to or removed from a group. When one of these events happens, the direct sync automatically forwards those changes to Entra ID.

The _full sync_ happens when the provider is initially created and when it is saved. The full sync goes through all users and groups matching the **User filtering** options set and will create/update them in Entra ID. After the initial sync, authentik will run a full sync every four hours to ensure the consistency of users and groups.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Every four hours..." Maybe we should say "This schedule cannot be changed from the configuration" or something.

Tana M Berry added 2 commits May 16, 2024 15:30
@tanberry tanberry merged commit a3634ab into main May 16, 2024
69 of 70 checks passed
@tanberry tanberry deleted the docs-new-entra branch May 16, 2024 22:00
@MaBauMeBad
Copy link

Just my 2 cents, but i think the naming should be matching.
What i mean with that is, as Provider you Name it Entra. As Source its Azure AD.
But its the same and therefore should be called the same to avoid irritation.

kensternberg-authentik added a commit that referenced this pull request May 17, 2024
* main:
  web: bump @sentry/browser from 7.114.0 to 8.2.1 in /web in the sentry group across 1 directory (#9757)
  core, web: update translations (#9714)
  core: bump sentry-sdk from 2.1.1 to 2.2.0 (#9753)
  core: bump selenium from 4.20.0 to 4.21.0 (#9754)
  core: bump msgraph-sdk from 1.2.0 to 1.4.0 (#9755)
  core: bump github.com/sethvargo/go-envconfig from 1.0.1 to 1.0.2 (#9756)
  web: bump chromedriver from 124.0.3 to 125.0.0 in /tests/wdio (#9758)
  website/docs: new PR for the Entra provider docs (ignore old one) (#9741)
  root: include task_id in events and logs (#9749)
  web: bump the esbuild group in /web with 2 updates (#9745)
  web: bump esbuild from 0.21.2 to 0.21.3 in /web (#9746)
  web: bump the storybook group across 1 directory with 7 updates (#9747)
kensternberg-authentik added a commit that referenced this pull request May 17, 2024
* dev:
  web: bump @sentry/browser from 7.114.0 to 8.2.1 in /web in the sentry group across 1 directory (#9757)
  core, web: update translations (#9714)
  core: bump sentry-sdk from 2.1.1 to 2.2.0 (#9753)
  core: bump selenium from 4.20.0 to 4.21.0 (#9754)
  core: bump msgraph-sdk from 1.2.0 to 1.4.0 (#9755)
  core: bump github.com/sethvargo/go-envconfig from 1.0.1 to 1.0.2 (#9756)
  web: bump chromedriver from 124.0.3 to 125.0.0 in /tests/wdio (#9758)
  website/docs: new PR for the Entra provider docs (ignore old one) (#9741)
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.

None yet

4 participants