# Run the Jira Access Request Plugin

This guide explains how to set up the Teleport Access Request plugin for Jira. Teleport's Jira integration allows you to manage Access Requests as Jira issues.

This integration is hosted on Teleport Cloud

In Teleport Enterprise Cloud, Teleport manages the Jira integration for you, and you can enroll the Jira integration from the Teleport Web UI.

Visit the Teleport Web UI and on the left sidebar, click **Add New** followed by **Integration**:

![Enroll an Access Request plugin](/docs/assets/images/enroll-ee64e35054da594e264c55422bf39c7b.png)

On the "Select Integration Type" menu, click the tile for your integration. You will see a page with instructions to set up the integration, as well as a form that you can use to configure the integration.

## How it works

The Teleport Jira plugin synchronizes a Jira project board with the Access Requests processed by your Teleport cluster. When you change the status of an Access Request within Teleport, the plugin updates the board. And when you update the status of an Access Request on the board, the plugin notifies a Jira webhook run by the plugin, which modifies the Access Request in Teleport.

## Prerequisites

- A running Teleport Enterprise cluster. If you want to get started with Teleport, [sign up](https://goteleport.com/signup) for a free trial or [set up a demo environment](https://goteleport.com/docs/get-started/deploy-community.md).

- The `tctl` and `tsh` clients.

  Installing `tctl` and `tsh` clients

  1. Determine the version of your Teleport cluster. The `tctl` and `tsh` clients must be at most one major version behind your Teleport cluster version. Send a GET request to the Proxy Service at `/v1/webapi/find` and use a JSON query tool to obtain your cluster version. Replace teleport.example.com:443 with the web address of your Teleport Proxy Service:

     ```
     $ TELEPORT_DOMAIN=teleport.example.com:443
     $ TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')"
     ```

  2. Follow the instructions for your platform to install `tctl` and `tsh` clients:

     **Mac**

     Download the signed macOS .pkg installer for Teleport, which includes the `tctl` and `tsh` clients:

     ```
     $ curl -O https://cdn.teleport.dev/teleport-${TELEPORT_VERSION?}.pkg
     ```

     In Finder double-click the `pkg` file to begin installation.

     ---

     DANGER

     Using Homebrew to install Teleport is not supported. The Teleport package in Homebrew is not maintained by Teleport and we can't guarantee its reliability or security.

     ---

     **Windows - Powershell**

     ```
     $ curl.exe -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-windows-amd64-bin.zip
     Unzip the archive and move the `tctl` and `tsh` clients to your %PATH%
     NOTE: Do not place the `tctl` and `tsh` clients in the System32 directory, as this can cause issues when using WinSCP.
     Use %SystemRoot% (C:\Windows) or %USERPROFILE% (C:\Users\<username>) instead.
     ```

     **Linux**

     All of the Teleport binaries in Linux installations include the `tctl` and `tsh` clients. For more options (including RPM/DEB packages and downloads for i386/ARM/ARM64) see our [installation page](https://goteleport.com/docs/installation.md).

     ```
     $ curl -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz
     $ tar -xzf teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz
     $ cd teleport
     $ sudo ./install
     Teleport binaries have been copied to /usr/local/bin
     ```

**Recommended:** Configure Machine & Workload Identity to provide short-lived Teleport credentials to the plugin. Before following this guide, follow a Machine & Workload Identity [deployment guide](https://goteleport.com/docs/machine-workload-identity/deployment.md) to run the `tbot` binary on your infrastructure.

- A Jira account with permissions to create applications and webhooks.

- A registered domain name for the Jira webhook. Jira notifies the webhook of changes in your project board.

- An environment where you will run the Jira plugin. This is either:

  - A Linux virtual machine with ports `80` and `8081` open, plus a means of accessing the host (e.g., OpenSSH with an SSH port exposed to your workstation).
  - A Kubernetes cluster deployed via a cloud provider. This guide shows you how to allow traffic to the Jira plugin via a `LoadBalancer` service, so your environment must support services of this type.

- A means of providing TLS credentials for the Jira webhook run by the plugin. **TLS certificates must not be self signed.** For example, you can obtain TLS credentials for the webhook with Let's Encrypt by using an [ACME client](https://letsencrypt.org/docs/client-options/).

  - If you run the plugin on a Linux server, you must provide TLS credentials to a directory available to the plugin.
  - If you run the plugin on Kubernetes, you must write these credentials to a secret that the plugin can read. This guide assumes that the name of the secret is `teleport-plugin-jira-tls`.

- To check that you can connect to your Teleport cluster, sign in with `tsh login`, then verify that you can run `tctl` commands using your current credentials.

  For example, run the following command, assigning teleport.example.com to the domain name of the Teleport Proxy Service in your cluster and email\@example.com to your Teleport username:

  ```
  $ tsh login --proxy=teleport.example.com --user=email@example.com
  $ tctl status
  Cluster  teleport.example.com
  Version  18.7.3
  CA pin   sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678
  ```

  If you can connect to the cluster and run the `tctl status` command, you can use your current credentials to run subsequent `tctl` commands from your workstation. If you host your own Teleport cluster, you can also run `tctl` commands on the computer that hosts the Teleport Auth Service for full permissions.

## Step 1/8. Define RBAC resources

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

For the purpose of this guide, we will define an `editor-requester` role, which can request the built-in `editor` role, and an `editor-reviewer` role that can review requests for the `editor` role.

Create a file called `editor-request-rbac.yaml` with the following content:

```
kind: role
version: v7
metadata:
  name: editor-reviewer
spec:
  allow:
    review_requests:
      roles: ['editor']
---
kind: role
version: v7
metadata:
  name: editor-requester
spec:
  allow:
    request:
      roles: ['editor']
      thresholds:
        - approve: 1
          deny: 1

```

Create the roles you defined:

```
$ tctl create -f editor-request-rbac.yaml
role 'editor-reviewer' has been created
role 'editor-requester' has been created
```

---

TIP

You can also create and edit roles using the Web UI. Go to **Access -> Roles** and click **Create New Role** or pick an existing role to edit.

---

Allow yourself to review requests by users with the `editor-requester` role by assigning yourself the `editor-reviewer` role.

Assign the `editor-reviewer` role to your Teleport user by running the appropriate commands for your authentication provider:

**Local User**

1. Retrieve your local user's roles as a comma-separated list:

   ```
   $ ROLES=$(tsh status -f json | jq -r '.active.roles | join(",")')
   ```

2. Edit your local user to add the new role:

   ```
   $ tctl users update $(tsh status -f json | jq -r '.active.username') \
     --set-roles "${ROLES?},editor-reviewer"
   ```

3. Sign out of the Teleport cluster and sign in again to assume the new role.

**GitHub**

1. Open your `github` authentication connector in a text editor:

   ```
   $ tctl edit github/github
   ```

2. Edit the `github` connector, adding `editor-reviewer` to the `teams_to_roles` section.

   The team you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the team must include your user account and should be the smallest team possible within your organization.

   Here is an example:

   ```
     teams_to_roles:
       - organization: octocats
         team: admins
         roles:
           - access
   +       - editor-reviewer

   ```

3. Apply your changes by saving and closing the file in your editor.

4. Sign out of the Teleport cluster and sign in again to assume the new role.

**SAML**

1. Retrieve your `saml` configuration resource:

   ```
   $ tctl get --with-secrets saml/mysaml > saml.yaml
   ```

   Note that the `--with-secrets` flag adds the value of `spec.signing_key_pair.private_key` to the `saml.yaml` file. Because this key contains a sensitive value, you should remove the saml.yaml file immediately after updating the resource.

2. Edit `saml.yaml`, adding `editor-reviewer` to the `attributes_to_roles` section.

   The attribute you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the group must include your user account and should be the smallest group possible within your organization.

   Here is an example:

   ```
     attributes_to_roles:
       - name: "groups"
         value: "my-group"
         roles:
           - access
   +       - editor-reviewer

   ```

3. Apply your changes:

   ```
   $ tctl create -f saml.yaml
   ```

4. Sign out of the Teleport cluster and sign in again to assume the new role.

**OIDC**

1. Retrieve your `oidc` configuration resource:

   ```
   $ tctl get oidc/myoidc --with-secrets > oidc.yaml
   ```

   Note that the `--with-secrets` flag adds the value of `spec.signing_key_pair.private_key` to the `oidc.yaml` file. Because this key contains a sensitive value, you should remove the oidc.yaml file immediately after updating the resource.

2. Edit `oidc.yaml`, adding `editor-reviewer` to the `claims_to_roles` section.

   The claim you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the group must include your user account and should be the smallest group possible within your organization.

   Here is an example:

   ```
     claims_to_roles:
       - name: "groups"
         value: "my-group"
         roles:
           - access
   +       - editor-reviewer

   ```

3. Apply your changes:

   ```
   $ tctl create -f oidc.yaml
   ```

4. Sign out of the Teleport cluster and sign in again to assume the new role.

Create a user called `myuser` who has the `editor-requester` role. This user cannot edit your cluster configuration unless they request the `editor` role:

```
$ tctl users add myuser --roles=editor-requester
```

`tctl` will print an invitation URL to your terminal. Visit the URL and log in as `myuser` for the first time, registering credentials as configured for your Teleport cluster.

Later in this guide, you will have `myuser` request the `editor` role so you can review the request using the Teleport plugin.

## Step 2/8. Define a Teleport Jira plugin user

The required permissions for the plugin are configured in the preset `access-plugin` role. To generate credentials for the plugin, define either a Machine ID bot user or a regular Teleport user.

**Machine & Workload Identity**

If you haven't set up a Machine ID bot yet, refer to the [deployment guide](https://goteleport.com/docs/machine-workload-identity/deployment.md) to run the `tbot` binary on your infrastructure.

Next, allow the Machine ID bot to generate credentials for the `access-plugin` role. You can do this using `tctl`, replacing `my-bot` with the name of your bot:

```
$ tctl bots update my-bot --add-roles access-plugin
```

**Long-lived identity files**

As with all Teleport users, the Teleport Auth Service authenticates the `access-plugin` user by issuing short-lived TLS credentials. In this case, we will need to request the credentials manually by *impersonating* the `access-plugin` role and user.

If you are running a self-hosted Teleport Enterprise deployment and are using `tctl` from the Auth Service host, you will already have impersonation privileges.

To grant your user impersonation privileges for `access-plugin`, define a user named `access-plugin` and a role named `access-plugin-impersonator` by adding the following YAML document into a file called `access-plugin-impersonator.yaml`:

```
kind: user
metadata:
  name: access-plugin
spec:
  roles: ['access-plugin']
version: v2
---
kind: role
version: v7
metadata:
  name: access-plugin-impersonator
spec:
  allow:
    impersonate:
      roles:
      - access-plugin
      users:
      - access-plugin

```

Create the user and role:

```
$ tctl create -f access-plugin-impersonator.yaml
user "access-plugin" has been created
role "access-plugin-impersonator" has been created
```

---

TIP

You can also create and edit roles using the Web UI. Go to **Access -> Roles** and click **Create New Role** or pick an existing role to edit.

---

Assign this role to the user you plan to use to generate credentials for the `access-plugin` role and user:

Assign the `access-plugin-impersonator` role to your Teleport user by running the appropriate commands for your authentication provider:

**Local User**

1. Retrieve your local user's roles as a comma-separated list:

   ```
   $ ROLES=$(tsh status -f json | jq -r '.active.roles | join(",")')
   ```

2. Edit your local user to add the new role:

   ```
   $ tctl users update $(tsh status -f json | jq -r '.active.username') \
     --set-roles "${ROLES?},access-plugin-impersonator"
   ```

3. Sign out of the Teleport cluster and sign in again to assume the new role.

**GitHub**

1. Open your `github` authentication connector in a text editor:

   ```
   $ tctl edit github/github
   ```

2. Edit the `github` connector, adding `access-plugin-impersonator` to the `teams_to_roles` section.

   The team you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the team must include your user account and should be the smallest team possible within your organization.

   Here is an example:

   ```
     teams_to_roles:
       - organization: octocats
         team: admins
         roles:
           - access
   +       - access-plugin-impersonator

   ```

3. Apply your changes by saving and closing the file in your editor.

4. Sign out of the Teleport cluster and sign in again to assume the new role.

**SAML**

1. Retrieve your `saml` configuration resource:

   ```
   $ tctl get --with-secrets saml/mysaml > saml.yaml
   ```

   Note that the `--with-secrets` flag adds the value of `spec.signing_key_pair.private_key` to the `saml.yaml` file. Because this key contains a sensitive value, you should remove the saml.yaml file immediately after updating the resource.

2. Edit `saml.yaml`, adding `access-plugin-impersonator` to the `attributes_to_roles` section.

   The attribute you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the group must include your user account and should be the smallest group possible within your organization.

   Here is an example:

   ```
     attributes_to_roles:
       - name: "groups"
         value: "my-group"
         roles:
           - access
   +       - access-plugin-impersonator

   ```

3. Apply your changes:

   ```
   $ tctl create -f saml.yaml
   ```

4. Sign out of the Teleport cluster and sign in again to assume the new role.

**OIDC**

1. Retrieve your `oidc` configuration resource:

   ```
   $ tctl get oidc/myoidc --with-secrets > oidc.yaml
   ```

   Note that the `--with-secrets` flag adds the value of `spec.signing_key_pair.private_key` to the `oidc.yaml` file. Because this key contains a sensitive value, you should remove the oidc.yaml file immediately after updating the resource.

2. Edit `oidc.yaml`, adding `access-plugin-impersonator` to the `claims_to_roles` section.

   The claim you should map to this role depends on how you have designed your organization's role-based access controls (RBAC). However, the group must include your user account and should be the smallest group possible within your organization.

   Here is an example:

   ```
     claims_to_roles:
       - name: "groups"
         value: "my-group"
         roles:
           - access
   +       - access-plugin-impersonator

   ```

3. Apply your changes:

   ```
   $ tctl create -f oidc.yaml
   ```

4. Sign out of the Teleport cluster and sign in again to assume the new role.

You will now be able to generate signed certificates for the `access-plugin` role and user.

## Step 3/8. Export the access plugin identity

Give the plugin access to a Teleport identity file. We recommend using Machine ID for this in order to produce short-lived identity files that are less dangerous if exfiltrated, though in demo deployments, you can generate longer-lived identity files with `tctl`:

**Machine & Workload Identity**

Configure `tbot` with an output that will produce the credentials needed by the plugin. As the plugin will be accessing the Teleport API, the correct output type to use is `identity`.

For this guide, the `directory` destination will be used. This will write these credentials to a specified directory on disk. Ensure that this directory can be written to by the Linux user that `tbot` runs as, and that it can be read by the Linux user that the plugin will run as.

Modify your `tbot` configuration to add an `identity` output.

If running `tbot` on a Linux server, use the `directory` output to write identity files to the `/opt/machine-id` directory:

```
services:
- type: identity
  destination:
    type: directory
    # For this guide, /opt/machine-id is used as the destination directory.
    # You may wish to customize this. Multiple outputs cannot share the same
    # destination.
    path: /opt/machine-id

```

If running `tbot` on Kubernetes, write the identity file to Kubernetes secret instead:

```
services:
  - type: identity
    destination:
      type: kubernetes_secret
      name: teleport-plugin-jira-identity

```

If operating `tbot` as a background service, restart it. If running `tbot` in one-shot mode, execute it now.

You should now see an `identity` file under `/opt/machine-id` or a Kubernetes secret named `teleport-plugin-jira-identity`. This contains the private key and signed certificates needed by the plugin to authenticate with the Teleport Auth Service.

**Long-lived identity files**

Like all Teleport users, `access-plugin` needs signed credentials in order to connect to your Teleport cluster. You will use the `tctl auth sign` command to request these credentials.

The following `tctl auth sign` command impersonates the `access-plugin` user, generates signed credentials, and writes an identity file to the local directory:

```
$ tctl auth sign --user=access-plugin --out=identity
```

The plugin connects to the Teleport Auth Service's gRPC endpoint over TLS.

The identity file, `identity`, includes both TLS and SSH credentials. The plugin uses the SSH credentials to connect to the Proxy Service, which establishes a reverse tunnel connection to the Auth Service. The plugin uses this reverse tunnel, along with your TLS credentials, to connect to the Auth Service's gRPC endpoint.

Certificate Lifetime

By default, `tctl auth sign` produces certificates with a relatively short lifetime. For production deployments, we suggest using [Machine & Workload Identity](https://goteleport.com/docs/machine-workload-identity/introduction.md) to programmatically issue and renew certificates for your plugin. See our Machine & Workload Identity [getting started guide](https://goteleport.com/docs/machine-workload-identity/getting-started.md) to learn more.

Note that you cannot issue certificates that are valid longer than your existing credentials. For example, to issue certificates with a 1000-hour TTL, you must be logged in with a session that is valid for at least 1000 hours. This means your user must have a role allowing a `max_session_ttl` of at least 1000 hours (60000 minutes), and you must specify a `--ttl` when logging in:

```
$ tsh login --proxy=teleport.example.com --ttl=60060
```

If you are running the plugin on a Linux server, create a data directory to hold certificate files for the plugin:

```
$ sudo mkdir -p /var/lib/teleport/plugins/api-credentials
$ sudo mv identity /var/lib/teleport/plugins/api-credentials
```

If you are running the plugin on Kubernetes, create a Kubernetes secret that contains the Teleport identity file:

```
$ kubectl -n teleport create secret generic --from-file=identity teleport-plugin-jira-identity
```

Once the Teleport credentials expire, you will need to renew them by running the `tctl auth sign` command again.

## Step 4/8. Install the Teleport Jira plugin

Install the Teleport Jira plugin following the instructions below, which depend on whether you are deploying the plugin on a host (e.g., an EC2 instance) or a Kubernetes cluster.

The Teleport Jira plugin must run on a host or Kubernetes cluster that can access both Jira and your Teleport Proxy Service (or Teleport Enterprise Cloud tenant).

**Download**

Access Request Plugins are available as `amd64` and `arm64` Linux binaries for downloading. Replace `ARCH` with your required version.

```
$ curl -L -O https://cdn.teleport.dev/teleport-access-jira-v18.7.3-linux-ARCH-bin.tar.gz
$ tar -xzf teleport-access-jira-v18.7.3-linux-ARCH-bin.tar.gz
$ cd teleport-access-jira
$ sudo ./install
```

Make sure the binary is installed:

```
$ teleport-jira version
teleport-jira v18.7.3 git:teleport-jira-v18.7.3-fffffffff go1.25.9
```

**Docker Image**

```
$ docker pull public.ecr.aws/gravitational/teleport-plugin-jira:18.7.3
```

Make sure the plugin is installed by running the following command:

```
$ docker run public.ecr.aws/gravitational/teleport-plugin-jira:18.7.3 version
teleport-jira v18.7.3 1.25.9
```

For a list of available tags, visit [Amazon ECR Public Gallery](https://gallery.ecr.aws/gravitational/teleport-plugin-jira).

**From Source**

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/).

```
$ git clone https://github.com/gravitational/teleport -b branch/v18
$ cd teleport/integrations/access/jira
$ git checkout v18.7.3
$ make build/teleport-jira
```

Move the `teleport-jira` binary into your PATH.

Make sure the binary is installed:

```
$ teleport-jira version
teleport-jira v18.7.3 git:teleport-jira-v18.7.3-fffffffff go1.25.9
```

**Helm Chart**

Allow Helm to install charts that are hosted in the Teleport Helm repository:

```
$ helm repo add teleport https://charts.releases.teleport.dev
```

Update the cache of charts from the remote repository:

```
$ helm repo update
```

## Step 5/8. Set up a Jira project

In this section, you will create a Jira a project that the Teleport plugin can modify when a Teleport user creates or updates an Access Request. The plugin then uses the Jira webhook to monitor the state of the board and respond to any changes in the tickets it creates.

### Create a project for managing Access Requests

In Jira, find the top navigation bar and click **Projects** -> **Create project**. Select **Kanban** for the template, then **Use template**. Click **Select a company-managed project**.

You'll see a screen where you can enter a name for your project. In this guide, we assume that your project is called "Teleport Access Requests", which receives the key `TAR` by default.

Make sure "Connect repositories, documents, and more" is unset, then click **Create project**.

In the three-dots menu on the upper right of your new board, click **Board settings**, then click **Columns**. Edit the statuses in your board so it contains the following four:

1. Pending
2. Approved
3. Denied
4. Expired

Create a column with the same name as each status. The result should be the following:

![Jira board setup](/docs/assets/images/board-setup-1a96ce1badd54771bba6b58723a1125f.png)

---

WARNING

If your project board does not contain these (and only these) columns, each with a status of the same name, the Jira Access Request plugin will behave in unexpected ways. Remove all other columns and statuses.

---

Click **Back to board** to review your changes.

### Retrieve your Jira API token

Obtain an API token that the Access Request plugin uses to make changes to your Jira project. Click the gear menu at the upper right of the screen, then click **Atlassian account settings**. Click **Security** > **Create and manage API tokens** > **Create API token**.

Choose any label and click **Copy**. Paste the API token into a convenient location (e.g., a password manager or local text document) so you can use it later in this guide when you configure the Jira plugin.

### Set up a Jira webhook

Now that you have generated an API key that the Teleport Jira plugin uses to manage your project, enable Jira to notify the Teleport Jira plugin when your project is updated by creating a webhook.

Return to Jira. Click the gear menu on the upper right of the screen. Click **System** > **WebHooks** > **Create a WebHook**.

**Executable**

Enter "Teleport Access Request Plugin" in the "Name" field. In the "URL" field, enter the domain name you created for the plugin earlier, plus port `8081`.

**Helm Chart**

Enter "Teleport Access Request Plugin" in the "Name" field. In the "URL" field, enter the domain name you created for the plugin earlier, plus port `443`.

The webhook needs to be notified only when an issue is created, updated, or deleted. You can leave all the other boxes empty.

Click **Create**.

## Step 6/8. Configure the Jira Access Request plugin

Earlier, you retrieved credentials that the Jira plugin uses to connect to Teleport and the Jira API. You will now configure the plugin to use these credentials and run the Jira webhook at the address you configured earlier.

### Create a configuration file

**Executable or Docker**

The Teleport Jira plugin uses a configuration file in TOML format. Generate a boilerplate configuration by running the following command (the plugin will not run unless the config file is in `/etc/teleport-jira.toml`):

```
$ teleport-jira configure | sudo tee /etc/teleport-jira.toml > /dev/null
```

This should result in a configuration file like the one below:

```
# Example Jira plugin configuration TOML file
[teleport]
# Proxy Service domain and HTTPS port
# e.g., example.teleport.sh:443
auth_server = "" 
# Teleport identity file location
identity = ""
# Refresh identity file on a periodic basis.
refresh_identity = true

[jira]
# JIRA URL
url = ""        
# JIRA username
username = ""   
# JIRA API token
api_token = ""  
# JIRA Project key
project = ""    

[http]
# URL on which webhook server is accessible externally, for example,
# [https://]teleport-jira.example.com
public_addr = "" 
# TLS private key
https_key_file = ""  
# TLS certificate
https_cert_file = "" 

[log]
# Logger output. Could be "stdout", "stderr" or "/var/lib/teleport/jira.log"
output = "stderr" 
# Logger severity. Could be "INFO", "ERROR", "DEBUG" or "WARN".
severity = "INFO" 


```

**Helm chart**

The Helm chart for the Jira plugin uses a YAML values file to configure the plugin. On your local workstation, create a file called `teleport-jira-helm.yaml` based on the following example:

```
teleport:
  # Teleport Proxy Service domain name and HTTPS port. If you are using Teleport
  # Enterprise Cloud, this should be in the form "your-account.teleport.sh:443"
  address: ""
  # Secret containing a Teleport identity document, e.g., teleport-plugin-jira-identity
  identityFromSecret: ""
  # Path within the secret containing the identity file.
  identitySecretPath: ""

jira:
  url: ""       # URL of the Jira instance
  username: ""  # Email of the bot user
  apiToken: ""  # Token of the bot user
  project: ""   # Project where issues will be created

http:
  publicAddress: "" 
  # Secret containing the TLS certificate, e.g., teleport-plugin-jira-tls
  tlsFromSecret: ""
  # tlsKeySecretPath:  tls.key                # Name of the key inside the secret
  # tlsCertSecretPath: tls.crt                # Name of the certificate inside the secret

log:
  output: stderr  # Logger output. Could be "stdout", "stderr" or "/var/lib/teleport/jira.log"
  severity: INFO  # Logger severity. Could be "INFO", "ERROR", "DEBUG" or "WARN".

serviceType: ClusterIP


```

### Edit the configuration file

Open the configuration file created for the Teleport Jira plugin and update the following fields:

**`[teleport]`**

The Jira plugin uses this section to connect to your Teleport cluster:

**Executable**

**`addr`**: Include the hostname and HTTPS port of your Teleport Proxy Service or Teleport Enterprise Cloud account (e.g., `teleport.example.com:443` or `mytenant.teleport.sh:443`).

**`identity`**: Fill this in with the path to the identity file you exported earlier.

**`client_key`**, **`client_crt`**, **`root_cas`**: Comment these out, since we are not using them in this configuration.

**Helm Chart**

**`address`**: Include the hostname and HTTPS port of your Teleport Proxy Service or Teleport Enterprise Cloud tenant (e.g., `teleport.example.com:443` or `mytenant.teleport.sh:443`).

**`identitySecretName`**: Fill in the `identitySecretName` field with the name of the Kubernetes secret you created earlier.

**`identitySecretPath`**: Fill in the `identitySecretPath` field with the path of the identity file within the Kubernetes secret. If you have followed the instructions above, this will be `identity`.

If you are providing credentials to the plugin using a `tbot` binary that runs on a Linux server, make sure the value of `identity` is the same as the path of the identity file you configured `tbot` to generate, `/opt/machine-id/identity`.

Configure the plugin to periodically reload the identity file, ensuring that it does not attempt to connect to the Teleport Auth Service with expired credentials.

Add the following to the `teleport` section of the configuration:

```
refresh_identity = true

```

**Executable**

### `jira`

**url:** The URL of your Jira tenant, e.g., `https://[your-jira].atlassian.net`.

**username:** The username you were logged in as when you created your API token.

**api\_token:** The Jira API token you retrieved earlier.

**project:** The project key for your project, which in our case is `TAR`.

You can leave `issue_type` as `Task` or remove the field, as `Task` is the default.

### `http`

The `[http]` setting block describes how the plugin's webhook works.

**listen\_addr** indicates the address that the plugin listens on, and defaults to `:8081`. If you opened port `8081` on your plugin host as we recommended earlier in the guide, you can leave this option unset.

**public\_addr** is the public address of your webhook. This is the domain name you added to the DNS A record you created earlier.

**https\_key\_file** and **https\_cert\_file** correspond to the private key and certificate you obtained before following this guide. Use the following values, assigning example.com to the domain name you created for the plugin earlier:

- **https\_key\_file:**

  ```
  $ /var/teleport-jira/tls/certificates/acme-v02.api.letsencrypt.org-directory/example.com/example.com.key
  ```

- **https\_cert\_file:**

  ```
  $ /var/teleport-jira/tls/certificates/acme-v02.api.letsencrypt.org-directory/example.com/example.com.crt
  ```

**Helm Chart**

### `jira`

**url:** The URL of your Jira tenant, e.g., `https://[your-jira].atlassian.net`.

**username:** The username you were logged in as when you created your API token.

**apiToken:** The API token you retrieved earlier.

**project:** The project key for your project, which in our case is `TAR`.

You can leave `issueType` as `Task` or remove the field, as `Task` is the default.

### `http`

The `http` setting block describes how the plugin's webhook works.

**publicAddress:** The public address of your webhook. This is the domain name you created for your webhook. (We will create a DNS record for this domain name later.)

**tlsFromSecret:** The name of a Kubernetes secret containing TLS credentials for the webhook. Use `teleport-plugin-jira-tls`.

## Step 7/8. Run the Jira plugin

After finishing your configuration, you can now run the plugin and test your Jira-based Access Request flow:

**Executable**

Run the following on your Linux host:

```
$ sudo teleport-jira start
INFO   Starting Teleport Jira Plugin 12.1.1: jira/app.go:112
INFO   Plugin is ready jira/app.go:142
```

**Helm Chart**

Install the Helm chart for the Teleport Jira plugin:

```
$ helm install teleport-plugin-jira teleport/teleport-plugin-jira \
  --namespace teleport \
  --values values.yaml \
  --version 18.7.3
```

Create a DNS record that associates the webhook's domain name with the address of the load balancer created by the Jira plugin Helm chart.

See whether the load balancer has a domain name or IP address:

```
$ kubectl -n teleport get services/teleport-plugin-jira
NAME                   TYPE           CLUSTER-IP      EXTERNAL-IP                          PORT(S)                      AGE
teleport-plugin-jira   LoadBalancer   10.100.135.75   abc123.us-west-2.elb.amazonaws.com   80:30625/TCP,443:31672/TCP   134m
```

If the `EXTERNAL-IP` field has a domain name for the value, create a `CNAME` record in which the domain name for your webhook points to the domain name of the load balancer.

If the `EXTERNAL-IP` field's value is an IP address, create a DNS `A` record instead.

You can then generate signed TLS credentials for the Jira plugin, which expects them to be written to a Kubernetes secret.

### Check the status of the webhook

Confirm that the Jira webhook has started serving by sending a GET request to the `/status` endpoint. If the webhook is running, it will return a `200` status code with no document body:

**Executable**

```
$ curl -v https://example.com:8081/status 2>&1 | grep "^< HTTP/2"
< HTTP/2 200
```

**Helm Chart**

```
$ curl -v https://example.com:443/status 2>&1 | grep "^< HTTP/2"
< HTTP/2 200
```

### Create an Access Request

Sign in to your cluster as the `myuser` user you created earlier and create an Access Request:

**As an Admin**

A Teleport admin can create an Access Request for another user with `tctl`:

```
$ tctl request create myuser --roles=editor
```

**As a User**

Users can use `tsh` to create an Access Request and log in with approved roles:

```
$ tsh request create --roles=editor
Seeking request approval... (id: 8f77d2d1-2bbf-4031-a300-58926237a807)
```

**From the Web UI**

Users can request access using the Web UI by visiting "Identity", clicking "Access Requests" and then "New Request":

![Creating an Access Request using the Web UI](/docs/assets/images/request-access-be784784ab25db7e651c87817044f082.png)

When you create the request, you will see a new task in the "Pending" column of the Access Requests board:

![New Access Request](/docs/assets/images/new-request-1dc68b5dfd816bbe215a8ef5d05ad9c6.png)

### Resolve the request

Move the card corresponding to your new Access Request to the "Denied" column, then click the card and navigate to Teleport. You will see that the Access Request has been denied.

---

AUDITING ACCESS REQUESTS

Anyone with access to the Jira project board can modify the status of Access Requests reflected on the board. You can check the Teleport audit log to ensure that the right users are reviewing the right requests.

When auditing Access Request reviews, check for events with the type `Access Request Reviewed` in the Teleport Web UI.

---

## Step 8/8. Set up systemd

---

TIP

This step is only applicable if you are running the Teleport Jira plugin on a Linux machine.

---

In production, we recommend starting the Teleport plugin daemon via an init system like systemd. Here's the recommended Teleport plugin service unit file for systemd:

```
[Unit]
Description=Teleport Jira Plugin
After=network.target

[Service]
Type=simple
Restart=on-failure
ExecStart=/usr/local/bin/teleport-jira start --config=/etc/teleport-jira.toml
ExecReload=/bin/kill -HUP $MAINPID
PIDFile=/run/teleport-jira.pid

[Install]
WantedBy=multi-user.target

```

Save this as `teleport-jira.service` or another [unit file load path](https://www.freedesktop.org/software/systemd/man/systemd.unit.html#unit%20file%20load%20path) supported by systemd.

```
$ sudo systemctl enable teleport-jira
$ sudo systemctl start teleport-jira
```

## Troubleshooting

Access Request plugins need permissions to list and read any Teleport resource types included in a request. This is because, when the plugin receives a resource request, it queries the Teleport Auth Service API for data about the requested resources.

If you receive an error message similar to the following, the Teleport roles for the Access Request plugin's identity do not have permissions to perform one or more operations against the Teleport API. In the example below, the Access Request plugin needs `list` and `read` permissions on the `user_group` resource:

```
ERRO   Failed to process request error:[
ERROR REPORT:
Original Error: *interceptors.RemoteError access denied to perform action "list" on "user_group", access denied to perform action "read" on "user_group"

```

Make sure the Teleport roles for the Access Request plugin's identity include permissions to list requested resources. To resolve the error above, for example, you could grant the following role to the Access Request plugin's identity:

```
kind: role
version: v7
metadata:
  name: read-user-groups
spec:
  allow:
    rules:
      - resources: [user_group]
        verbs: [list, read]

```