From bb0b8c3ffa001d4db6610462fd89ff0341f0ef55 Mon Sep 17 00:00:00 2001 From: Logan Davis <38335829+logand22@users.noreply.github.com> Date: Wed, 13 Apr 2022 15:14:25 -0500 Subject: [PATCH] Update teleport-plugin guides to reference docker images for downloads (#11617) --- .../workflow/ssh-approval-jira-cloud.mdx | 39 +++++++++++------ .../workflow/ssh-approval-jira-server.mdx | 42 ++++++++++++------- .../workflow/ssh-approval-mattermost.mdx | 39 +++++++++++------ .../workflow/ssh-approval-pagerduty.mdx | 39 +++++++++++------ .../workflow/ssh-approval-slack.mdx | 15 ++++--- docs/pages/setup/guides/fluentd.mdx | 13 ++++-- 6 files changed, 126 insertions(+), 61 deletions(-) diff --git a/docs/pages/enterprise/workflow/ssh-approval-jira-cloud.mdx b/docs/pages/enterprise/workflow/ssh-approval-jira-cloud.mdx index fbdaa0e959ecc..cc3676c13dfdd 100644 --- a/docs/pages/enterprise/workflow/ssh-approval-jira-cloud.mdx +++ b/docs/pages/enterprise/workflow/ssh-approval-jira-cloud.mdx @@ -82,19 +82,34 @@ In the webhook settings page, make sure that the webhook will only send Issue Up We recommend installing Teleport plugins alongside the Teleport Proxy. This is an ideal location as plugins have a low memory footprint, and will require both public internet access -and Teleport Auth access. We currently only provide linux-amd64 binaries, you can also -compile these plugins from [source](https://github.com/gravitational/teleport-plugins/tree/master/access/jira). +and Teleport Auth Service access. -```code -$ wget https://get.gravitational.com/teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ tar -xzf teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ cd teleport-access-jira/ -$ ./install -$ which teleport-jira -# /usr/local/bin/teleport-jira -``` - -Run `./install` in from 'teleport-jira' or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ curl -L -O https://get.gravitational.com/teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -xzf teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ cd teleport-access-jira + $ ./install + ``` + + + To install from source you need `git` and `go` installed. If you do not have Go installed, visit the Go [downloads page](https://go.dev/dl/). + + ```code + # Checkout teleport-plugins + $ git clone https://github.com/gravitational/teleport-plugins.git + $ cd teleport-plugins/access/jira + $ make + ``` +Run `./install` from `teleport-jira` or place the executable in `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-jira:(=teleport.plugin.version=) + ``` + + ### Configuration file diff --git a/docs/pages/enterprise/workflow/ssh-approval-jira-server.mdx b/docs/pages/enterprise/workflow/ssh-approval-jira-server.mdx index 5bf61b69dee15..5d3b747fd2b81 100644 --- a/docs/pages/enterprise/workflow/ssh-approval-jira-server.mdx +++ b/docs/pages/enterprise/workflow/ssh-approval-jira-server.mdx @@ -94,22 +94,34 @@ Teleport Jira Plugin will listen for a webhook that Jira Server sends when a req We recommend installing Teleport plugins alongside the Teleport Proxy. This is an ideal location as plugins have a low memory footprint, and will require both public internet access -and Teleport Auth access. We currently only provide linux-amd64 binaries, you can also -compile these plugins from [source](https://github.com/gravitational/teleport-plugins/tree/master/access/jira). - -```code -$ wget https://get.gravitational.com/teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ tar -xzf teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ cd teleport-access-jira/ -$ sudo ./install -# Teleport Jira Plugin binaries have been copied to /usr/local/bin -# You can run teleport-jira configure > /etc/teleport-jira.toml to bootstrap your config file. -$ which teleport-jira -# /usr/local/bin/teleport-jira -``` - -Run `sudo ./install` from 'teleport-jira' or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. +and Teleport Auth Service access. + + + ```code + $ curl -L -O https://get.gravitational.com/teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -xzf teleport-access-jira-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ cd teleport-access-jira + $ ./install + ``` + + + To install from source you need `git` and `go` installed. If you do not have Go installed, visit the Go [downloads page](https://go.dev/dl/). + + ```code + # Checkout teleport-plugins + $ git clone https://github.com/gravitational/teleport-plugins.git + $ cd teleport-plugins/access/jira + $ make + ``` +Run `./install` from `teleport-jira` or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-jira:(=teleport.plugin.version=) + ``` + + ## Configuration file diff --git a/docs/pages/enterprise/workflow/ssh-approval-mattermost.mdx b/docs/pages/enterprise/workflow/ssh-approval-mattermost.mdx index 48439b8c0f9f6..ec82bcbd46069 100644 --- a/docs/pages/enterprise/workflow/ssh-approval-mattermost.mdx +++ b/docs/pages/enterprise/workflow/ssh-approval-mattermost.mdx @@ -73,19 +73,34 @@ We'll reference these files later when [configuring the plugins](#configuring-ma We recommend installing the Teleport Plugins alongside the Teleport Proxy. This is an ideal location as plugins have a low memory footprint, and will require both public internet access -and Teleport Auth access. We currently only provide linux-amd64 binaries, you can also -compile these plugins from [source](https://github.com/gravitational/teleport-plugins/tree/master/access/mattermost). +and Teleport Auth Service access. -```code -$ wget https://get.gravitational.com/teleport-access-mattermost-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ tar -xzf teleport-access-mattermost-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ cd teleport-access-mattermost -$ ./install -$ which teleport-mattermost -# /usr/local/bin/teleport-mattermost -``` - -Run `./install` in from 'teleport-mattermost' or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ curl -L -O https://get.gravitational.com/teleport-access-mattermost-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -xzf teleport-access-mattermost-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ cd teleport-access-mattermost + $ ./install + ``` + + + To install from source you need `git` and `go` installed. If you do not have Go installed, visit the Go [downloads page](https://go.dev/dl/). + + ```code + # Checkout teleport-plugins + $ git clone https://github.com/gravitational/teleport-plugins.git + $ cd teleport-plugins/access/mattermost + $ make + ``` +Run `./install` from `teleport-mattermost` or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-mattermost:(=teleport.plugin.version=) + ``` + + ### Configuring Mattermost bot diff --git a/docs/pages/enterprise/workflow/ssh-approval-pagerduty.mdx b/docs/pages/enterprise/workflow/ssh-approval-pagerduty.mdx index 5a9aa8336fbca..5f4b679d50384 100644 --- a/docs/pages/enterprise/workflow/ssh-approval-pagerduty.mdx +++ b/docs/pages/enterprise/workflow/ssh-approval-pagerduty.mdx @@ -49,19 +49,34 @@ In your PagerDuty dashboard, go to **Configuration → API Access → Create New We recommend installing Teleport plugins alongside the Teleport Proxy. This is an ideal location as plugins have a low memory footprint, and will require both public internet access -and Teleport Auth access. We currently only provide linux-amd64 binaries, you can also -compile these plugins from [source](https://github.com/gravitational/teleport-plugins/tree/master/access/pagerduty). +and Teleport Auth Service access. -```bash -$ wget https://get.gravitational.com/teleport-access-pagerduty-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ tar -xzf teleport-access-pagerduty-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz -$ cd teleport-access-pagerduty/ -$ ./install -$ which teleport-pagerduty -/usr/local/bin/teleport-pagerduty -``` - -Run `./install` in from 'teleport-pagerduty' or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ curl -L -O https://get.gravitational.com/teleport-access-pagerduty-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -xzf teleport-access-pagerduty-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ cd teleport-access-pagerduty + $ ./install + ``` + + + To install from source you need `git` and `go` installed. If you do not have Go installed, visit the Go [downloads page](https://go.dev/dl/). + + ```code + # Checkout teleport-plugins + $ git clone https://github.com/gravitational/teleport-plugins.git + $ cd teleport-plugins/access/pagerduty + $ make + ``` +Run `./install` from `teleport-pagerduty` or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-pagerduty:(=teleport.plugin.version=) + ``` + + ### Config file diff --git a/docs/pages/enterprise/workflow/ssh-approval-slack.mdx b/docs/pages/enterprise/workflow/ssh-approval-slack.mdx index 0b17ea53f6d14..aea17dcf44cf8 100644 --- a/docs/pages/enterprise/workflow/ssh-approval-slack.mdx +++ b/docs/pages/enterprise/workflow/ssh-approval-slack.mdx @@ -93,14 +93,14 @@ compile these plugins from [source](https://github.com/gravitational/teleport-pl ```code - $ curl -L https://get.gravitational.com/teleport-access-slack-v(=teleport.version=)-linux-amd64-bin.tar.gz - $ tar -xzf teleport-access-slack-v(=teleport.version=)-linux-amd64-bin.tar.gz + $ curl -L -O https://get.gravitational.com/teleport-access-slack-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -xzf teleport-access-slack-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz $ cd teleport-access-slack $ ./install ``` - To install from source you need `git` and `go >= (=teleport.golang=)` installed. + To install from source you need `git` and `go` installed. If you do not have Go installed, visit the Go [downloads page](https://go.dev/dl/). ```code # Checkout teleport-plugins @@ -108,12 +108,15 @@ compile these plugins from [source](https://github.com/gravitational/teleport-pl $ cd teleport-plugins/access/slack $ make ``` +Run `./install` from `teleport-slack` or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-slack:(=teleport.plugin.version=) + ``` - -Run `./install` from `teleport-slack` or place the executable in the appropriate `/usr/bin` or `/usr/local/bin` on the server installation. - ### Configuring the Teleport Slack plugin Teleport Slack uses a config file in TOML format. Generate a boilerplate config by diff --git a/docs/pages/setup/guides/fluentd.mdx b/docs/pages/setup/guides/fluentd.mdx index e03f9b4922121..9c0139897af99 100644 --- a/docs/pages/setup/guides/fluentd.mdx +++ b/docs/pages/setup/guides/fluentd.mdx @@ -85,15 +85,20 @@ from Teleport's events API, and forwards them to Fluentd. ```code - $ curl -L -O https://get.gravitational.com/teleport-event-handler-v(=teleport.version=)-linux-amd64-bin.tar.gz - $ tar -zxvf teleport-event-handler-v(=teleport.version=)-linux-amd64-bin.tar.gz + $ curl -L -O https://get.gravitational.com/teleport-event-handler-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + $ tar -zxvf teleport-event-handler-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz ``` ```code - $ curl -L -O https://get.gravitational.com/teleport-event-handler-v(=teleport.version=)-darwin-amd64-bin.tar.gz - $ tar -zxvf teleport-event-handler-v(=teleport.version=)-linux-amd64-bin.tar.gz + $ curl -L -O https://get.gravitational.com/teleport-event-handler-v(=teleport.plugin.version=)-darwin-amd64-bin.tar.gz + $ tar -zxvf teleport-event-handler-v(=teleport.plugin.version=)-linux-amd64-bin.tar.gz + ``` + + + ```code + $ docker pull quay.io/gravitational/teleport-plugin-event-handler:(=teleport.plugin.version=) ```