flashduty-knowledge-base 1.2.4 → 1.2.5

package/dist/iife/en.js

@@ -311,7 +311,7 @@ attachment_stripped = true
 
 Currently, all alerts pushed to Flashduty through email integration are set to Warning severity.
 
-`,o=`---
+`,i=`---
 title: "Nightingale/FlashCat Integration"
 description: "Push alert events from Nightingale (n9e) or Flashcat to Flashduty via webhook. When an alert is triggered, send a trigger event to Flashduty; when an alert recovers, send a recovery event to Flashduty"
 date: "2024-05-11T10:00:00+08:00"
@@ -469,7 +469,7 @@ Nightingale/Flashcat to Flashduty alert severity mapping:
     
 </details>
 
-`,i=`---
+`,o=`---
 title: "Prometheus Integration Guide"
 description: "Push Prometheus alert events to Flashduty through AlertManager using webhooks. When an alert is triggered, it sends a trigger event to Flashduty, and when the alert recovers, it sends a recovery event."
 date: "2024-05-11T10:00:00+08:00"
@@ -1554,7 +1554,7 @@ Alibaba Cloud SLS monitoring to Flashduty alert severity mapping:
 | 2                | Info      | Info |
 
 </div>
-`,u={CustomAlert:t,Email:a,N9e:o,Prometheus:i,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:h,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
+`,u={CustomAlert:t,Email:a,N9e:i,Prometheus:o,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:h,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
 title: "AWS CloudWatch Integration"
 description: "Sync AWS CloudWatch alert events to Flashduty via webhook to achieve automated alert noise reduction"
 date: "2024-05-11T10:00:00+08:00"
@@ -5480,6 +5480,7 @@ The following event types are currently supported, with more potentially being a
 |    i_rslv    | Close incident (automatically or manually) |
 |   i_reopen   | Reopen incident |
 |   i_merge    | Manually merge incidents |
+|   i_comm     | Add comment |
 |  i_r_title   | Update incident title |
 |   i_r_desc   | Update incident description |
 |  i_r_impact  | Update incident impact |
@@ -6149,6 +6150,8 @@ CloseTime | int64 | No | Close time, EndTime is alert recovery time, CloseTime i
 
 Below are specific instructions for each notification channel. 
 
+<div class="feishu_app hide">
+
 ## Feishu/Lark App
 ---
 You need to configure \`Integration Center - IM - Feishu/Lark\` integration first to send message cards. If custom content is not set, the system default template will be used to render all label information:
@@ -6192,6 +6195,9 @@ If you want to display only key label information, you can refer to the code sni
 {{if (index .Labels "mode")}}mode：{{index .Labels "mode"}}{{end}}
 {{if (index .Labels "runbook_url")}}runbook_url：{{toHtml (index .Labels "runbook_url")}}{{end}}
 \`\`\`
+</div>
+
+<div class="dingtalk_app hide">
 
 ## Dingtalk App
 ---
@@ -6234,6 +6240,9 @@ If you want to display only key label information, you can refer to the code sni
 {{if (index .Labels "mode")}}**mode**：{{index .Labels "mode"}}{{end}}
 {{if (index .Labels "runbook_url")}}**runbook_url**：{{index .Labels "runbook_url"}}{{end}}
 \`\`\`
+</div>
+
+<div class="wecom_app hide">
 
 ## WeCom App
 ---
@@ -6270,6 +6279,9 @@ As shown below:
 
 
 **Note: WeCom limits card length. In the template rendering area, you can render up to 8 lines of content. Content beyond 8 lines will be hidden**
+</div>
+
+<div class="slack_app hide">
 
 ## Slack App
 ---
@@ -6313,6 +6325,9 @@ If you want to display only key label information, you can refer to the code sni
 {{if (index .Labels "mode")}}*mode*：{{index .Labels "mode"}}{{end}}
 {{if (index .Labels "runbook_url")}}*runbook_url*：{{index .Labels "runbook_url"}}{{end}}
 \`\`\` 
+</div>
+
+<div class="zoom hide">
 
 ## Zoom Bot
 ---
@@ -6412,6 +6427,10 @@ If you want to display only key label information, you can refer to the code sni
   ]
 }
 \`\`\`
+</div>
+
+
+<div class="sms hide">
 
 ## SMS
 ---
@@ -6420,6 +6439,9 @@ If custom content is not set, the system default template will be used for notif
 \`\`\`
 You have a pending incident: {{toHtml .Title}}, Channel: {{.ChannelName}}, Severity: {{.IncidentSeverity}}{{if gt .AlertCnt 1}}, Grouped {{.AlertCnt}} alerts{{end}}
 \`\`\`
+</div>
+
+<div class="email hide">
 
 ## Email
 ---
@@ -6619,4 +6641,86 @@ When you need to route alerts to different channels based on alert payload infor
 
 </div>
 
+`,JiraSync:`---
+title: "Jira Sync"
+description: "Sync incidents with Jira issues through Jira Sync Webhook."
+date: "2024-05-11T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/jira-sync"
+---
+
+Through Jira Sync Webhook, you can associate and synchronize Flashduty incidents with Jira Issues, enabling integration between Flashduty and Jira.
+
+## Prerequisites
+- This integration is compatible with Jira Cloud, as well as versions 7.x and 8.x of Jira Server and Jira Data Center.
+- Currently, only one-way synchronization of incident information and status to Jira is supported. Information in Jira will not sync back to Flashduty.
+- For Jira Cloud, use an API Token in the password field during authorization configuration; for Jira Server or Data Center, use your Jira account password.
+
+## Getting API Token in Jira Cloud （Jira Server and Data Center please skip）
+
+- After logging into Jira Cloud, click your profile picture in the top right corner and select **Manage Account**.
+- On the **Manage Account** page, select the **Security** tab.
+- On the **Security** page, click **Create and manage API tokens**.
+- In the **Create and manage API tokens** dialog, enter an API token name and select an expiration time.
+- Click **Create** to generate the API token.
+- Copy the API token value and paste it into the API token field in Flashduty's authorization configuration.
+
+## Configuring Integration in Flashduty
+
+### 1. Create and Authenticate Jira Integration
+<div class="hide">
+
+In the Integration Center, select **Webhook**, choose **Jira Sync** integration, and fill in the following authentication information.
+
+</div>
+
+- **Jira Platform Type**: Choose based on your version. For Data Center version, select Self-hosted (Server).
+- **Service URL**: For Cloud version, enter your actual access URL, e.g., https://your-domain.atlassian.net. For Server version, enter your service access URL, e.g., https://your-jira-server-url.com.
+- **Username**: Your Jira account name. For Cloud version, enter your email; for Server version, enter your Jira username.
+- **API Token/Password**: Your Jira account credentials. For Cloud version, enter API Token; for Server version, enter your Jira account password.
+- After completion, click **Next** to proceed with configuration.
+
+**About Permissions**: Ensure your Jira account has permissions to access relevant projects, issue types, and create issues. Using an administrator account is recommended.
+
+### 2. Jira Integration Configuration
+
+- **Integration Name**: Define a name for this integration.
+- **Trigger Mode**:
+    - Automatic: Configure conditions for Flashduty to automatically sync qualifying incidents to Jira.
+    - Manual: Manually trigger Jira sync from the incident details page's more actions menu (integration name serves as trigger name).
+- **Project ID**: Select the target Jira project for synchronization.
+- **Issue Type**: Select the target Jira issue type.
+- **Channel**: Select the channel where this integration will be active. Only incidents within this channel can sync to Jira.
+- **Severity Mapping**: If the selected issue type doesn't support priority fields, this mapping cannot be configured.
+- **Custom Field Mapping**: Choose to sync certain or all incident labels and custom field content to Jira fields (text type fields only).
+
+### 3. About Updates
+
+- For incidents with existing Jira issues, updates to severity or status will automatically update in Jira, but Jira updates won't sync back to Flashduty.
+- Comments sync to Jira, but Jira comments won't sync back to Flashduty.
+- Updates to incident title, description, labels, or other fields won't update in Jira.
+
+### 4. Flashduty to Jira Mapping
+
+#### Field Mapping
+
+| Jira | Flashduty |
+| ---------- | -------- |
+| Summary | Title |
+| Description | Description |
+| Priority | Severity |
+| Reporter | Integration configured user |
+| Comments | Comments |
+
+#### Status Mapping
+
+| Jira | Flashduty |
+| ---------- | -------- |
+| Todo | Pending |
+| In Progress | In Progress |
+| Done | Resolved |
+
+### 5. Important Notes
+
+- Flashduty syncs information according to default field mappings and your custom field configurations. If your Jira issue type has required fields without mapping relationships, Jira issue creation may fail.
+- Jira issue details are accessed using project KEY + number format. If you modify the project KEY, saved issue URLs in Flashduty may become inaccessible, so please modify project KEYs with caution.
 `};n.FlashDocsEn=u})(window);