Skip to content

Document HA for Access Request plugins#24945

Merged
ptgott merged 3 commits intomasterfrom
paul.gottschling/8970-plugin-ha
May 2, 2023
Merged

Document HA for Access Request plugins#24945
ptgott merged 3 commits intomasterfrom
paul.gottschling/8970-plugin-ha

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Apr 20, 2023

Closes #8970

Add an "Architecture" section to the Access Request plugin index page that describes how Access Request plugins run, including what an HA setup looks like.

Copy link
Copy Markdown
Contributor

@alexfornuto alexfornuto left a comment

Choose a reason for hiding this comment

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

I made some suggestions to reduce verbosity, otherwise 👍.

Comment thread docs/pages/access-controls/access-request-plugins/index.mdx Outdated
Comment thread docs/pages/access-controls/access-request-plugins/index.mdx
Comment on lines +32 to +35
You can run multiple instances of an Access Request plugin for high
availability. To do so, run each instance in a separate availability zone. There
is no need for additional configuration or load balancing, as plugins avoid
creating duplicate requests to their third-party APIs.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Tightening:

Suggested change
You can run multiple instances of an Access Request plugin for high
availability. To do so, run each instance in a separate availability zone. There
is no need for additional configuration or load balancing, as plugins avoid
creating duplicate requests to their third-party APIs.
By running multiple instances of an Access Request plugin in separate availability
zones, you can achieve high availability. Plugins avoid creating duplicate requests
to third-party APIs, so no load balancing is required.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've suggested:

You can run multiple instances of an Access Request plugin for high availability
by deploying each instance in a separate availability zone. There is no need for
additional configuration or load balancing, as plugins avoid creating duplicate
requests to their third-party APIs.

In the sentence, "By running multiple instances of an Access Request plugin in separate availability
zones, you can achieve high availability," I think putting "you can achieve high availability" at the end of the sentence makes it less clear, since we have to get to the end to know what the sentence is about.

ptgott added 2 commits April 25, 2023 17:20
Closes #8970

Add an "Architecture" section to the Access Request plugin index page
that describes how Access Request plugins run, including what an HA
setup looks like.
@ptgott ptgott force-pushed the paul.gottschling/8970-plugin-ha branch from 408380e to faa9a82 Compare April 25, 2023 21:20
Comment thread docs/pages/access-controls/access-request-plugins/index.mdx Outdated
Comment thread docs/pages/access-controls/access-requests/resource-requests.mdx Outdated
Comment thread docs/pages/access-controls/access-requests/role-requests.mdx Outdated
@ptgott ptgott requested a review from stevenGravy May 2, 2023 21:33
@ptgott ptgott added this pull request to the merge queue May 2, 2023
Merged via the queue into master with commit c2b3ca3 May 2, 2023
@ptgott ptgott deleted the paul.gottschling/8970-plugin-ha branch May 2, 2023 22:15
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ptgott See the table below for backport results.

Branch Result
branch/v11 Create PR
branch/v12 Create PR
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Mention HA in the Plugin Docs

3 participants