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 upgrade page #10742

Merged
merged 24 commits into from
Aug 8, 2024
Merged

website/docs: new upgrade page #10742

merged 24 commits into from
Aug 8, 2024

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Aug 2, 2024

This PR adds a new Upgrade page.
Also:

  • adds a link from the Rel Notes template to this Upgrade doc
  • adds a Note in Upgrade docs and in Rel Note template about versions must match

I wanted to use a warning within a tab, and Docusaurus and MDX do allow this, but... the local build kept choking on it, so I gave up. Happy to get any advice there.

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

@tanberry tanberry requested a review from a team as a code owner August 2, 2024 20:24
@tanberry tanberry marked this pull request as draft August 2, 2024 20:24
Copy link

netlify bot commented Aug 2, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 586c682
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66b3e7ea2f090a00085d03fe
😎 Deploy Preview https://deploy-preview-10742--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 Aug 2, 2024

Deploy Preview for authentik-storybook canceled.

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

@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 32.5%, saving 21.30 KB.

Filename Before After Improvement Visual comparison
website/docs/installation/version1.png 65.64 KB 44.34 KB -32.5% View diff

156 images did not require optimisation.

Copy link

codecov bot commented Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.62%. Comparing base (b9bf01f) to head (586c682).
Report is 55 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main   #10742    +/-   ##
========================================
  Coverage   92.62%   92.62%            
========================================
  Files         721      734    +13     
  Lines       35359    36039   +680     
========================================
+ Hits        32750    33381   +631     
- Misses       2609     2658    +49     
Flag Coverage Δ
e2e 49.43% <ø> (-0.32%) ⬇️
integration 25.18% <ø> (-0.18%) ⬇️
unit 90.17% <ø> (+0.12%) ⬆️

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 Aug 2, 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-586c6828429a8a8b939f1af41d8604fe3bc7b667
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-586c6828429a8a8b939f1af41d8604fe3bc7b667-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-586c6828429a8a8b939f1af41d8604fe3bc7b667

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-586c6828429a8a8b939f1af41d8604fe3bc7b667-arm64

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

website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
@4d62
Copy link
Contributor

4d62 commented Aug 3, 2024

little comments to your wip

@tanberry tanberry marked this pull request as ready for review August 5, 2024 22:43
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.

This looks correct. But it's currently not working for me, and I think it's about the system, not the documentation.

```
#### 1. Retrieve latest `docker-compose.yml` file

- Linux:
Copy link
Contributor

Choose a reason for hiding this comment

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

why not use curl for both

website/docs/installation/upgrade.mdx Show resolved Hide resolved
Copy link
Contributor

@4d62 4d62 left a comment

Choose a reason for hiding this comment

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

github is forcing me to add a comment

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
website/docs/installation/upgrade.mdx Outdated Show resolved Hide resolved
website/docs/installation/upgrade.mdx Show resolved Hide resolved
@tanberry tanberry requested a review from rissson August 7, 2024 21:33
@tanberry tanberry merged commit 8f69d09 into main Aug 8, 2024
71 checks passed
@tanberry tanberry deleted the docs-upgrade branch August 8, 2024 13:40
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.

5 participants