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 federated region concept and operations pages. #24477

Merged
merged 5 commits into from
Nov 19, 2024
Merged

Conversation

jrasell
Copy link
Member

@jrasell jrasell commented Nov 18, 2024

Description

In order to help users understand multi-region federated deployments, this change adds two new sections to the website.

The first expands the architecture page, so we can add further detail over time with an initial federation page. The second adds a federation operations page which goes into failure planning and mitigation.

Links

Jira: https://hashicorp.atlassian.net/browse/NET-10100

Deploy previews

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.

In order to help users understand multi-region federated
deployments, this change adds two new sections to the website.

The first expands the architecture page, so we can add further
detail over time with an initial federation page. The second adds
a federation operations page which goes into failure planning and
mitigation.
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.

style guide nits and suggestions to consolidate

Thanks for creating this!

website/content/docs/concepts/architecture/federation.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/architecture/federation.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/architecture/federation.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/architecture/federation.mdx Outdated Show resolved Hide resolved
website/content/docs/concepts/architecture/federation.mdx Outdated Show resolved Hide resolved
website/content/docs/operations/federation/failure.mdx Outdated Show resolved Hide resolved
website/content/docs/operations/federation/failure.mdx Outdated Show resolved Hide resolved
website/content/docs/operations/federation/failure.mdx Outdated Show resolved Hide resolved
website/content/docs/operations/federation/failure.mdx Outdated Show resolved Hide resolved
website/content/docs/operations/federation/failure.mdx Outdated Show resolved Hide resolved
Copy link
Member

@schmichael schmichael left a comment

Choose a reason for hiding this comment

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

Fantastic work! 0 blockers from me, so feel free to ignore my nitpicks.

@jrasell jrasell added 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 labels Nov 19, 2024
Co-authored-by: Aimee Ukasick <[email protected]>
Co-authored-by: Michael Schurter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.9.x+ent Changes are backported to 1.9.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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants