flashduty-knowledge-base 1.2.4 → 1.2.5

package/dist/en.d.ts

@@ -53,5 +53,6 @@ declare const docs: {
     CustomAction: string;
     Templates: string;
     HuaweiyunAPM: string;
+    JiraSync: string;
 };
 export default docs;

package/dist/esm/en.js

@@ -469,7 +469,7 @@ Nightingale/Flashcat to Flashduty alert severity mapping:
     
 </details>
 
-`,o=`---
+`,i=`---
 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"
@@ -651,7 +651,7 @@ Prometheus to Flashduty severity mapping:
 
 
 
-`,i=`---
+`,o=`---
 title: "Grafana Integration"
 description: "Sync Grafana alert events to Flashduty via webhook to achieve automated alert noise reduction."
 date: "2024-05-11T10:00:00+08:00"
@@ -4051,7 +4051,7 @@ Choose this method when you need to route alerts to different channels based on
 |Notice|Info|Info|
 
 </div>
-`,N=`---
+`,P=`---
 title: "Volcengine Log Service (TLS) Alert Events"
 description: "Sync Volcengine Log Service (TLS) alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2024-07-05T10:00:00+08:00"
@@ -4188,7 +4188,7 @@ Choose this method when you need to route alerts to different channels based on
 </div>
 
 </div>
-`,P=`---
+`,N=`---
 title: "OpManager Alert Events"
 description: "Sync OpManager alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2024-07-05T10:00:00+08:00"
@@ -5246,7 +5246,7 @@ Integrate WeCom third-party application to receive and respond to alerts within
 7. **Incident notification fails with \`WeCom License Not Activated\`?**
 
    - Contact Flashduty customer service or dedicated support for license purchase and activation
-`,V=`---
+`,z=`---
 title: "Slack Integration"
 description: "Integrate with Slack to receive and respond to alerts within Slack"
 date: "2024-05-11T10:00:00+08:00"
@@ -5300,7 +5300,7 @@ Integrate with Slack to receive and respond to alerts within Slack.
 
 8. **Slack App shows Other questions error**
    - Try again, as this might be an unrecorded issue
-   - If the error persists, contact customer support`,z=`---
+   - If the error persists, contact customer support`,V=`---
 title: "Microsoft Teams Integration"
 description: "Integrate Microsoft Teams as a third-party application to receive and respond to alerts within Microsoft Teams"
 date: "2024-05-11T10:00:00+08:00"
@@ -5395,7 +5395,7 @@ Please check in Integration Center => Instant Messaging => Microsoft Teams under
 Currently not supported
 </details>
 
-`,K=`Configure alert webhooks to receive HTTP callbacks at your specified URL when alerts have specific actions (such as triggering or closing). The callback content includes the latest key information about the alert, allowing integration with your custom tools.
+`,J=`Configure alert webhooks to receive HTTP callbacks at your specified URL when alerts have specific actions (such as triggering or closing). The callback content includes the latest key information about the alert, allowing integration with your custom tools.
 
 <span id="EventTypes"></span>
 
@@ -5563,7 +5563,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
 4. **Trusted IP whitelist for push sources?**
    - {ip_whitelist}
    - May be updated in the future, please check periodically
-`,Z=`Configure incident webhooks to receive HTTP callbacks at your specified URL when incidents have specific actions (such as triggering or closing). The callback content includes the latest key information about the incident, allowing integration with your custom tools.
+`,K=`Configure incident webhooks to receive HTTP callbacks at your specified URL when incidents have specific actions (such as triggering or closing). The callback content includes the latest key information about the incident, allowing integration with your custom tools.
 
 <span id="EventTypes"></span>
 
@@ -5586,6 +5586,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 |
@@ -5769,7 +5770,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
 
 4. **Trusted IP whitelist for push sources?**
    - {ip_whitelist}
-   - May be updated in the future, please check periodically`,J=`Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
+   - May be updated in the future, please check periodically`,Z=`Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
 
 ## I. Creating Actions
 
@@ -6017,6 +6018,88 @@ When an incident occurs and is confirmed to be caused by a change, directly trig
 ### Update Status Page
 
 When an incident is confirmed to affect online services, trigger external status page updates to prompt`,Q=`---
+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.
+`,X=`---
 title: "Configure Notification Templates"
 description: "Customize notification content through template configuration"
 date: "2024-05-10T10:00:00+08:00"
@@ -6255,6 +6338,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:
@@ -6298,6 +6383,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
 ---
@@ -6340,6 +6428,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
 ---
@@ -6376,6 +6467,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
 ---
@@ -6419,6 +6513,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
 ---
@@ -6518,6 +6615,10 @@ If you want to display only key label information, you can refer to the code sni
   ]
 }
 \`\`\`
+</div>
+
+
+<div class="sms hide">
 
 ## SMS
 ---
@@ -6526,6 +6627,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 +6723,4 @@ If custom content is not set, the system default template will be used for notif
 As shown below:
 <img src="https://download.flashcat.cloud/flashduty/doc/en/fd/template-mail-1.png" width="800">
 
-`,X={CustomAlert:n,Email:t,N9e:a,Prometheus:o,Grafana:i,Zabbix:s,UptimeKuma:r,AliyunARMS:l,AliyunCmEvent:d,AliyunCm:c,AliyunSLS:e,AWSCW:e,AzureMonitor:h,BaiDuBCM:u,HuaWeiCES:g,InfluxDB:p,OpenFalcon:m,PagerDuty:f,TencentBK:y,TencentCLS:v,TencentCm:b,TencentEb:w,OceanBase:C,Graylog:k,Skywalking:I,Sentry:S,Jiankongbao:A,AWSEventBridge:L,Dynatrace:_,HuaweiyunLTS:F,GoogleCM:x,Zilliz:Y,Splunk:R,AppDynamics:T,SolarWinds:U,VolcEngineMetric:E,VolcEngineEvent:D,VolcEngineTLS:N,OpManager:P,Meraki:M,StateCloud:W,Guance:G,CustomChange:O,Jira:j,Lark:$,Dingtalk:H,Wecom:B,Slack:V,MicrosoftTeams:z,AlertWebhook:K,IncidentWebhook:Z,CustomAction:J,Templates:Q,HuaweiyunAPM:q};module.exports=X;
+`,ee={CustomAlert:n,Email:t,N9e:a,Prometheus:i,Grafana:o,Zabbix:s,UptimeKuma:r,AliyunARMS:l,AliyunCmEvent:d,AliyunCm:c,AliyunSLS:e,AWSCW:e,AzureMonitor:h,BaiDuBCM:u,HuaWeiCES:g,InfluxDB:p,OpenFalcon:m,PagerDuty:f,TencentBK:y,TencentCLS:v,TencentCm:b,TencentEb:w,OceanBase:C,Graylog:k,Skywalking:I,Sentry:S,Jiankongbao:A,AWSEventBridge:L,Dynatrace:_,HuaweiyunLTS:F,GoogleCM:x,Zilliz:Y,Splunk:R,AppDynamics:T,SolarWinds:U,VolcEngineMetric:E,VolcEngineEvent:D,VolcEngineTLS:P,OpManager:N,Meraki:M,StateCloud:W,Guance:G,CustomChange:O,Jira:j,Lark:$,Dingtalk:H,Wecom:B,Slack:z,MicrosoftTeams:V,AlertWebhook:J,IncidentWebhook:K,CustomAction:Z,Templates:X,HuaweiyunAPM:q,JiraSync:Q};module.exports=ee;