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

docs: add auth-methods section in acl concepts #24917

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

Conversation

mismithhisler
Copy link
Member

@mismithhisler mismithhisler commented Jan 22, 2025

Description

Expands on the existing ACL documentation by adding an Auth Method dropdown with sections on JWT and OIDC which contain information related to setting up and debugging both methods.

Most of this added documentation comes from the existing Consul docs, with changes that make sense for Nomad.

image

Testing & Reproduction steps

Links

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.

@mismithhisler mismithhisler self-assigned this Jan 22, 2025
@mismithhisler mismithhisler marked this pull request as ready for review January 22, 2025 20:10
@mismithhisler mismithhisler requested review from a team as code owners January 22, 2025 20:10
@mismithhisler mismithhisler requested a review from EnMod January 22, 2025 20:10
@aimeeu aimeeu added the theme/docs Documentation issues and enhancements label Jan 22, 2025
Copy link
Contributor

@EnMod EnMod left a comment

Choose a reason for hiding this comment

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

New content is showing up fine on the web-presence side, no errors in the build 👍 Deferring to other reviewers for content approval.

@aimeeu
Copy link
Contributor

aimeeu commented Jan 28, 2025

relates to #24892

@aimeeu aimeeu added backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/ent/1.7.x+ent Changes are backported to 1.7.x+ent backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/1.9.x backport to 1.9.x release line labels Jan 28, 2025
Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

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

Thanks @mismithhisler for porting this content over. I took the opportunity to apply style guide rules

website/content/docs/concepts/acl/auth-methods/jwt.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/acl/auth-methods/jwt.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/acl/auth-methods/jwt.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/acl/auth-methods/jwt.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/acl/auth-methods/oidc.mdx Outdated Show resolved Hide resolved
website/content/partials/jwt_claim_mapping_details.mdx Outdated Show resolved Hide resolved
website/content/partials/jwt_claim_mapping_details.mdx Outdated Show resolved Hide resolved
website/content/partials/jwt_claim_mapping_details.mdx Outdated Show resolved Hide resolved
website/content/partials/jwt_claim_mapping_details.mdx Outdated Show resolved Hide resolved
website/content/partials/jwt_claim_mapping_details.mdx Outdated Show resolved Hide resolved
@aimeeu
Copy link
Contributor

aimeeu commented Jan 28, 2025

backport labels - after DM with Michael, for CE, only add 1.9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.7.x+ent Changes are backported to 1.7.x+ent backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.9.x backport to 1.9.x release line theme/docs Documentation issues and enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants