From 7ef190ddd8b4e6dfc837b533663cd7c86a28db29 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Thu, 18 May 2023 10:41:21 -0400 Subject: [PATCH] Add diagrams to Access Request plugin guides This was mainly an experiment to see how we could use partial parameters with Mermaid diagrams, but also ensures that Access Request plugin docs have a diagram for easier architectural understanding. The Jira plugin works differently than the rest, so I did not include the diagram partial. --- .../ssh-approval-discord.mdx | 2 ++ .../ssh-approval-email.mdx | 2 ++ .../ssh-approval-mattermost.mdx | 2 ++ .../ssh-approval-msteams.mdx | 2 ++ .../ssh-approval-pagerduty.mdx | 2 ++ .../ssh-approval-slack.mdx | 2 ++ docs/pages/includes/plugins/diagram.mdx | 19 +++++++++++++++++++ 7 files changed, 31 insertions(+) create mode 100644 docs/pages/includes/plugins/diagram.mdx diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx index c75b0e30e8166..e2a0e609366c8 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-discord.mdx @@ -9,6 +9,8 @@ Access Requests. Users can then approve and deny Access Requests from within Discord, making it easier to implement security best practices without compromising productivity. +(!docs/pages/includes/plugins/diagram.mdx api="Discord" action="Listen for Access Requests" messages="Discord messages" !) + ## Prerequisites (!docs/pages/includes/commercial-prereqs-tabs.mdx!) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx index 8735c2a63f09a..5cbb721020198 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx @@ -9,6 +9,8 @@ at least some of their communications, Teleport's email plugin makes it straightforward to integrate Access Requests into your existing workflows, letting you implement security best practices without compromising productivity. +(!docs/pages/includes/plugins/diagram.mdx api="SMTP service" action="Listen for Access Requests" messages="Email messages" !) + ## Prerequisites (!docs/pages/includes/commercial-prereqs-tabs.mdx!) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx index 5de060f64a17f..6314aa672899b 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-mattermost.mdx @@ -9,6 +9,8 @@ Access Requests. Users can then approve and deny Access Requests by following th message link, making it easier to implement security best practices without compromising productivity. +(!docs/pages/includes/plugins/diagram.mdx api="Mattermost" action="Listen for Access Requests" messages="Mattermost messages" !) + ## Prerequisites (!docs/pages/includes/commercial-prereqs-tabs.mdx!) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-msteams.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-msteams.mdx index 8f4be8308eb0b..a13ac9c3f2b9a 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-msteams.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-msteams.mdx @@ -9,6 +9,8 @@ Access Requests. Users can then approve and deny Access Requests by following th message link, making it easier to implement security best practices without compromising productivity. +(!docs/pages/includes/plugins/diagram.mdx api="Microsoft Teams" action="Listen for Access Requests" messages="Microsoft Teams messages" !) + ## Prerequisites (!docs/pages/includes/commercial-prereqs-tabs.mdx!) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx index 87e7a3f45a020..abdb990085d02 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-pagerduty.mdx @@ -16,6 +16,8 @@ the on-call team for a service affected by an incident. This guide will explain how to set up Teleport's Access Request plugin for PagerDuty. +(!docs/pages/includes/plugins/diagram.mdx api="PagerDuty" action="Listen for Access Requests\nModify Access Requests" messages="Send notifications\nGet incident status" !) + ## Prerequisites (!docs/pages/includes/commercial-prereqs-tabs.mdx!) diff --git a/docs/pages/access-controls/access-request-plugins/ssh-approval-slack.mdx b/docs/pages/access-controls/access-request-plugins/ssh-approval-slack.mdx index d21b116113536..8bc1c324f0cbb 100644 --- a/docs/pages/access-controls/access-request-plugins/ssh-approval-slack.mdx +++ b/docs/pages/access-controls/access-request-plugins/ssh-approval-slack.mdx @@ -9,6 +9,8 @@ Access Requests. Users can then approve and deny Access Requests from within Slack, making it easier to implement security best practices without compromising productivity. +(!docs/pages/includes/plugins/diagram.mdx api="Slack" action="Listen for Access Requests" messages="Slack messages" !) + Here is an example of sending an Access Request via Teleport's Slack plugin: