Skip to content

docs: Add Docker to email access request plugin #33239

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.

Sign up for GitHub

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

Merged
lsgunn-teleport merged 1 commit into from
Oct 10, 2023
Merged

docs: Add Docker to email access request plugin #33239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions docs/pages/access-controls/access-request-plugins/ssh-approval-email.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ regularly.

## Step 1/7. Define RBAC resources

Before you set up the email plugin, you will need to enable Role Access Requests
in your Teleport cluster.
Before you set up the email plugin, enable Role Access Requests in your Teleport cluster.

(!/docs/pages/includes/plugins/editor-request-rbac.mdx!)

Expand All @@ -42,11 +41,11 @@ in your Teleport cluster.
<Details title="Using a local SMTP server?">

If you are using a local SMTP server to test the plugin, you should install the
plugin on your local machine. This is because the plugin needs to dial out to
your SMTP server and perform any necessary DNS lookups in order to send email.
plugin on your local machine to ensure the plugin can connect to the SMTP server
and perform any necessary DNS lookups to send email.

Your Teleport cluster does *not* need to perform DNS lookups for your plugin, as
the plugin dials out to the Proxy Service or Auth Service.
Your Teleport cluster does *not* need to perform DNS lookups for your plugin
because the plugin dials out to the Teleport Proxy Service or Teleport Auth Service.

</Details>

Expand Down Expand Up @@ -94,10 +93,10 @@ chosen recipients.
### Create a config file

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">

The Teleport email plugin uses a config file in TOML format. Generate a
boilerplate config by running the following command:
The Teleport email plugin uses a configuration file in TOML format. Generate a
boilerplate configuration by running the following command:

```code
$ teleport-email configure | sudo tee /etc/teleport-email.toml
Expand All @@ -109,14 +108,14 @@ The email plugin Helm Chart uses a YAML values file to configure the plugin.
On your local workstation, create a file called `teleport-email-helm.yaml`
based on the following example:

```toml
```yaml
(!examples/resources/plugins/teleport-email-helm.yaml!)
```

</TabItem>
</Tabs>

### Edit the config file
### Edit the configuration file

Edit the configuration file for your environment. We will show you how to set
each value below.
Expand Down Expand Up @@ -212,7 +211,7 @@ it will look up the role being requested and identify the recipients to notify.
Here is an example of a `role_to_recipients` map:

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">

```toml
[role_to_recipients]
Expand Down Expand Up @@ -264,7 +263,7 @@ by adding the following to your `role_to_recipients` config, replacing
`YOUR_EMAIL_ADDRESS` with the appropriate address:

<Tabs>
<TabItem label="Executable" >
<TabItem label="Executable or Docker" >
```toml
[role_to_recipients]
"*" = "YOUR_EMAIL_ADDRESS"
Expand All @@ -287,7 +286,7 @@ Teleport email plugin to notify a static list of recipients for every Access
Request event by using the `delivery.recipients` field:

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">
```toml
[delivery]
recipients = ["eng@exmaple.com", "dev@example.com"]
Expand All @@ -310,7 +309,7 @@ recipient list to a `role_to_recipients` mapping under the wildcard value `"*"`.
You configuration should resemble the following:

<Tabs>
<TabItem label="Executable">
<TabItem label="Executable or Docker">

```toml
# /etc/teleport-email.toml
Expand Down Expand Up @@ -394,6 +393,13 @@ INFO Starting Teleport Access Email Plugin (): email/app.go:80
INFO Plugin is ready email/app.go:101
```
</TabItem>
<TabItem label="Docker">
Start the plugin:

```code
$ docker run -v <path-to-config>:/etc/teleport-email.toml public.ecr.aws/gravitational/teleport-plugin-email:(=teleport.version=) start
```
</TabItem>
<TabItem label="Helm Chart">
Install the plugin:

Expand Down