Skip to content

Latest commit

 

History

History
324 lines (265 loc) · 6.22 KB

teleport-plugin-jira.mdx

File metadata and controls

324 lines (265 loc) · 6.22 KB
Raw
title description
teleport-plugin-jira Chart Reference
Values that can be set using the teleport-plugin-jira Helm chart

The teleport-plugin-jira Helm chart runs the Jira Teleport plugin, which allows users to receive and manage Access Requests as tasks in a Jira project.

You can browse the source on GitHub.

This reference details available values for the teleport-plugin-jira chart.

(!docs/pages/includes/backup-warning.mdx!)

teleport.address

Type Default value Required?
string "" Yes

This parameter contains the host/port combination of the Teleport Auth Service or Proxy Service.

```yaml teleport: address: "teleport.example.com:3025" ``` ```code $ --set teleport.address="teleport.example.com:3025" ```

teleport.identitySecretName

Type Default value Required?
string "" Yes

Name of the Kubernetes secret that contains the credentials for the connection to the Auth Service or Proxy Service.

The secret should be in the following format:

apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: teleport-plugin-jira-identity
data:
  auth_id: ...

Check out the Jira Helm Chart documentation for more information about how to acquire these credentials.

```yaml teleport: identitySecretName: "teleport-plugin-jira-identity" ``` ```code $ --set teleport.identitySecretName="teleport-plugin-jira-identity" ```

teleport.identitySecretPath

Type Default value Required?
string "auth_id" No

Name of the key in the Kubernetes secret that holds the credentials for the connection to the Auth Service. If the secret follows the format above, it can be omitted.

```yaml teleport: identitySecretPath: "auth_id" ``` ```code $ --set teleport.identitySecretPath="auth_id" ```

jira.apiTokenFromSecret

Type Default value Required?
string "" No

Secret containing the Jira token of the bot user.

```yaml jira: apiTokenFromSecret: "teleport-jira-plugin-token" ``` ```code $ --set jira.apiTokenFromSecret="teleport-jira-plugin-token" ```

jira.apiTokenSecretPath

Type Default value Required?
string "jiraApiToken" No

Key where the token is located inside the secret specified by jira.apiTokenFromSecret.

```yaml jira: apiTokenSecretPath: "token" ``` ```code $ --set jira.apiTokenSecretPath="token" ```

jira.issueType

Type Default value Required?
string "Task" Yes

Issue type to be created when a new Access Request is made.

```yaml jira: issueType: Task ``` ```code $ --set jira.issueType=Task ```

jira.project

Type Default value Required?
string "" Yes

List of project who will receive notifications about Access Requests.

```yaml jira: project: MYPROJ ``` ```code $ --set jira.project=MYPROJ ```

jira.recipients

Type Default value Required?
array [] Yes

List of recipients who will receive notifications about Access Requests.

```yaml jira: recipients: - [email protected] - [email protected] ``` ```code $ --set jira.recipients[0]="[email protected]",jira.recipients[0]="[email protected]" ```

jira.token

Type Default value Required?
string "" No

Jira token of the bot user to impersonate when sending Access Request messages. It's only recommended for testing purposes. Please use jira.apiTokenFromSecret instead.

```yaml jira: token: "jiraapitoken" ``` ```code $ --set jira.token="jiraapitoken" ```

jira.url

Type Default value Required?
string "" Yes

Base URL of the Jira instance.

```yaml jira: url: "https://jira.example.com/" ``` ```code $ --set jira.url="https://jira.example.com/" ```

jira.username

Type Default value Required?
string "" Yes

Jira username or email address associated with the token.

```yaml jira: username: "[email protected]" ``` ```code $ --set jira.username="[email protected]" ```

log.output

Type Default value Required?
string stdout No

Logger output. Can be stdout, stderr or a file name, eg. /var/log/teleport/jira.log

```yaml log: output: /var/log/teleport/jira.log ``` ```code $ --set log.output="/var/log/teleport/jira.log" ```

log.severity

Type Default value Required?
string INFO No

Logger severity. Possible values are INFO, ERROR, DEBUG or WARN.

```yaml log: severity: DEBUG ``` ```code $ --set log.severity="DEBUG" ```