Skip to main content

Notification Management

It's tedious to manually check every time whether a build is complete or a deployment succeeded. With KIWI's notification system, you can know immediately when important events occur.

Benefits of using notifications
  • No need to wait for builds/deployments to finish
  • Know immediately when problems occur so you can respond quickly.
  • Take action as soon as security vulnerabilities are discovered.

Notification System Overview​

KIWI provides notifications via the bell icon in the top right of the screen.

  • Notification icon: Click the bell icon on the right side of the header to open the notification drawer.

  • Unread notification badge: If there are unread notifications, a red number badge is displayed on the icon.

    • Larger numbers mean more notifications to check.

  • Notification drawer: Clicking the icon slides open a list of recent notifications from the right side of the screen

Notification Types​

Let's learn about the types of notifications KIWI provides. You can quickly identify importance by color.

Build Notifications​

Notifications generated during the build process.

  • Build started (Blue): Docker image build started. Wait for completion.
  • Build succeeded (Green): Build complete. You can proceed with deployment.
  • Build failed (Red): Error during build. Check the log to identify the cause.

Deployment Notifications​

Notifications generated during the deployment process.

  • Deployment started (Blue): Deployment to selected environment started. Wait for completion.
  • Deployment succeeded (Green): Deployment complete. Verify the service is working properly.
  • Deployment failed (Red): Error during deployment. Check settings and resource status.
  • Rollback complete (Yellow): Rollback to previous version complete. Analyze cause and redeploy after fixing.

Security Notifications​

Notifications based on security scan results.

  • Critical vulnerability (Red): Critical vulnerability found. Immediate action required.
  • High vulnerability (Orange): High-risk vulnerability found. Take action as soon as possible.
  • Scan complete (Blue): Security scan complete. Review the results.
When you receive a Critical vulnerability notification

Critical vulnerabilities are serious security issues that can be used in actual attacks. Immediately check the security analysis results for the affected service and take action.

System Notifications​

Notifications related to the overall system.

  • Incident occurred (Red): Service incident occurred. Immediate attention required.
  • Incident resolved (Green): Incident recovery complete. Rest easy, the problem is resolved.
  • System maintenance (Yellow): Scheduled maintenance notice. Check the maintenance time in advance.

Viewing Notifications​

Let's learn step by step how to check and respond to notifications.

Step 1: Open the Notification Drawer​

  1. Find the bell icon in the top right of the screen
  2. If there are unread notifications, the count is shown as a red badge
    • A visible number is a signal that you need to check.
  3. Click the icon to slide open the notification drawer from the right

Step 2: Review the Notification List​

Information you can see in the notification list.

  • Title: Summary of what event occurred. Example: "Build Failed", "Critical Vulnerability Found"
  • Content: Detailed description of the event. Example: "Error occurred during my-service build"
  • Time: When the notification was generated. Example: "5 minutes ago", "Today at 2:30 PM"
  • Service: Related service name. Example: "my-service", "api-gateway"

Step 3: Respond to Notifications​

Actions you can take after checking a notification.

  • Go to details: Click the notification to navigate directly to the related page

    • Clicking a build failed notification takes you to that service's build log page

  • Mark as read: Click the check icon on the right side of the notification to mark it as read

    • Mark confirmed notifications as read to keep organized.

  • Mark all as read: Use the "Mark all as read" button at the top of the drawer to mark all at once.

    • Useful when many notifications have accumulated.
Efficient notification checking habits

Mark notifications as read immediately after checking them. If unread notifications pile up, you might miss truly important ones.

Managing Notifications​

Let's learn how to effectively manage notifications.

Distinguishing Read Status​

Notifications are displayed differently based on read status.

  • Unread: Displayed with bold text and highlighted background. These are notifications not yet checked.
  • Read: Displayed with regular text and default background. These are already confirmed notifications.

Clearing Notifications​

Too many notifications can make management difficult. KIWI cleans them up automatically, but you can also clean up manually.

  • Auto-delete: Old notifications are automatically cleaned up after a certain period

    • Check important notifications in advance.

  • Manual delete: Individual notifications can be deleted if needed.

    • Delete notifications you no longer need to keep things clean

Real-World Usage Scenarios​

Let's see how to respond when you actually receive notifications in different scenarios.

Scenario 1: Responding to a Build Failure​

Situation

After pushing code, you were working on something else when a red badge appeared on the notification icon.

Response sequence:

  1. A red badge appears on the notification icon.
  2. Click the icon to open the notification drawer.
  3. View the "Build Failed: my-service" notification.
  4. Click the notification to navigate to the relevant service page
  5. Check the error cause in the build log
    • Usually compile errors, dependency issues, Dockerfile errors, etc.
  6. Fix the code and run a rebuild

Scenario 2: Responding to a Security Vulnerability​

Situation

A security scan completed and you received a "Critical Vulnerability Found" notification.

Response sequence:

  1. Click the "Critical Vulnerability Found" notification.
  2. Navigate to the security analysis results page
  3. Review the vulnerability details.
    • CVE number, affected packages, severity, etc.
  4. Update the affected package to a safe version.
  5. Run a rescan to confirm the vulnerability has been resolved.
What is a CVE?

CVE (Common Vulnerabilities and Exposures) is a unique identifier assigned to known security vulnerabilities. You can search by CVE number to find detailed information and solutions for that vulnerability.

Scenario 3: Monitoring Deployment Progress​

Situation

You started a deployment but want to know the progress while working on other things.

Monitoring sequence:

  1. When a deployment starts, a "Deployment Started" notification appears.
  2. Work on other things while waiting.
  3. When deployment completes, a "Deployment Succeeded" notification appears.
  4. Click the notification to navigate to the service page
  5. Open the Operate modal to verify that Pods/containers are running normally.
If you receive a deployment failure notification

Don't panic if you get a "Deployment Failed" notification. Check the logs to identify the cause, and you can roll back to the previous version if needed.

Notification Priority​

Not all notifications are equally important. Understanding notification priorities helps you respond more effectively.

  • Critical (Red background): Examples include build/deployment failures and critical vulnerabilities. Respond immediately.
  • High (Orange background): Examples include high vulnerabilities and incidents. Respond as soon as possible.
  • Normal (Default background): Examples include build/deployment successes and scan completions. Respond at scheduled times.
  • Info (Gray background): Examples include system information and maintenance announcements. Respond when convenient.
Response strategy by priority
  • Critical/High: Stop other work and check immediately.
  • Normal: Check at scheduled times like morning, midday, and end of day
  • Info: Check when you have free time

Best Practices​

Here are recommendations for effectively using notifications.

Efficient Notification Management​

  • Immediate review: Check and respond to Critical or High priority notifications immediately.

    • These notifications can directly impact services.

  • Regular review: Check Normal notifications at set times like morning, midday, and end of day

    • Three times a day is usually sufficient.

  • Mark as read: Mark notifications as read immediately after reviewing and handling them.

    • If unread notifications pile up, you might miss important ones.

Team Collaboration​

Managing notifications as a team

Notifications should be managed by the entire team, not individuals. There should be no situation where notifications go unchecked because someone is on vacation.

  • Mark notifications as read when a team member has reviewed them to prevent duplicate checking.
  • Share important notifications in team channels (Slack, etc.) to respond together.
  • Setting up a notification duty rotation is also a good approach

Troubleshooting​

Things to check when notifications aren't working properly.

Notifications are not arriving​

Possible cause: Browser notification permissions may be blocked.

Solution: Allow KIWI site notifications in browser settings.

  • Chrome: Click the lock icon to the left of the address bar > Site settings > Allow notifications.

Notification badge is not displaying​

Possible cause: This may be a browser cache issue.

Solution:

  • Refresh the page (F5)
  • Hard refresh (Ctrl+Shift+R)

Notification drawer is not opening​

Possible cause: This may be a temporary UI issue.

Solution:

  • Refresh the page
  • If the problem persists, try a different browser.
  • If it still doesn't work, contact the administrator