You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To maintain consistency, a GitHub workflow named **`banner-validate`** automatically validates all `banner-content.yaml` files against the schema defined in [`banner-schema.json`](./banner-schema.json).
33
51
@@ -47,26 +65,19 @@ To maintain consistency, a GitHub workflow named **`banner-validate`** automatic
47
65
- Review the error message in the PR checks.
48
66
- Compare your changes with the [schema](./banner-schema.json) and [examples in README](#usage-scenarios--examples).
The `banner-content.yaml` file defines one or more banners displayed in the Konflux UI. Each cluster has its own `banner-content.yaml` under its directory (e.g., `staging/stone-stage-p01/banner-content.yaml`).
53
71
54
-
###**Schema**
72
+
#### 2.2.1. <aname='Schema'></a>**Schema**
55
73
56
74
The schema for banner content is defined in [`banner-schema.json`](./banner-schema.json) and validated automatically by the `banner-validate` GitHub workflow on every PR.
57
75
58
76
The file must contain a **YAML list** where each item represents a banner configuration.
59
77
60
78
---
61
79
62
-
### **Important Behavior**
63
-
64
-
- The <strongstyle="color: red;">UI displays only the first valid active banner</strong> from the list, based on current date, time, and optional recurrence settings.
65
-
- If multiple banners are configured, <strongstyle="color: red;">order matters</strong>.
66
-
67
-
---
68
-
69
-
### **Required and Optional Fields for Each Banner**
80
+
#### 2.2.2. <aname='RequiredandOptionalFieldsforEachBanner'></a>**Required and Optional Fields for Each Banner**
70
81
71
82
📎 For the full schema used in CI validation, see banner-schema.json. This table is a human-friendly reference for banner authors.
72
83
@@ -86,9 +97,9 @@ The file must contain a **YAML list** where each item represents a banner config
@@ -177,7 +188,7 @@ When there are no events to announce:
177
188
178
189
---
179
190
180
-
##📝 How to submit a PR for Banner
191
+
### 2.4. <aname='HowtosubmitaPRforBanner'></a>📝 How to submit a PR for Banner
181
192
182
193
1. Locate the target cluster directory:
183
194
@@ -225,7 +236,18 @@ When there are no events to announce:
225
236
Purpose: Release announcement for Konflux 1.2
226
237
```
227
238
228
-
## ❓ Frequently Asked Questions
239
+
### 2.5. <a name='UIBehavior'></a>✅ UI Behavior
240
+
241
+
- The <strong style="color: red;">UI displays only the first valid active banner</strong> from the list, based on current date, time, and optional recurrence settings.
242
+
- If multiple banners are configured, <strong style="color: red;">order matters</strong>.
243
+
- <strong style="color: red;">Time-related fields like `startTime` and `endTime` are not displayed in the UI</strong>; they only control when the banner is active.
244
+
245
+
<strong>To convey duration or timing details, please include them within the `summary`.</strong>
246
+
247
+
- <strong style="color: red;">The `type` and `summary` fields are displayed directly in the UI</strong>.
248
+
- We enjoyed leveraging the [PatternFly Banner component (v5)](https://v5-archive.patternfly.org/components/banner/) to implement the UI, following its design principles for clarity and consistency.
- Why is only one banner shown even when multiple are configured?
231
253
@@ -245,41 +267,3 @@ When there are no events to announce:
245
267
246
268
<strong style="color: red;">📝 If multiple messages need to be shared at the same time, consider combining them into a well-written summary inside a single banner.</strong>
247
269
248
-
## 📢 Auto Alerts(WIP)
249
-
250
-
We enables the infrastructure team to automatically surface specific operational issues or warnings in the Konflux UI.
251
-
252
-
These alerts would be auto-generated from monitoring systems or automation scripts, written as Kubernetes ConfigMaps, and automatically picked up by the Konflux UI to inform users of system-wide conditions.
253
-
254
-
### ✅ Alert YAML Format
255
-
256
-
Each file under auto-alerts/ must be a valid Kubernetes ConfigMap, including at minimum:
257
-
258
-
```yaml
259
-
apiVersion: v1
260
-
kind: ConfigMap
261
-
metadata:
262
-
name: konflux-auto-alert-xyz
263
-
namespace: konflux-info
264
-
labels:
265
-
konflux-auto-alert: "true" # Required. UI filter alerts out by this label.
266
-
data:
267
-
auto-alert-content.yaml: |
268
-
enable: true
269
-
summary: "Builds are delayed due to maintenance"
270
-
type: "warning"
271
-
```
272
-
273
-
🔐 The data.banner-content.yaml should follow the schema defined in `auto-alert-schema.json`
274
-
275
-
### Folder Structure
276
-
277
-
```bash
278
-
279
-
auto-alerts/ # Alert ConfigMaps (one file = one alert)
280
-
.
281
-
├── alert-1.yaml # Fully valid ConfigMap YAML
282
-
├── alert-2.yaml
283
-
└── kustomization.yaml # Auto-generated, includes all alert YAMLs
0 commit comments