lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Docs theme updates (#2971)

Browse Source 
* Update architecture diagram and theme colors

* Update state and proxy diagrams
This commit is contained in:
Desislava Marinova
2026-03-24 08:30:57 +02:00
committed by GitHub
parent 2f2a52485a
commit b961ae133f
14 changed files with 129 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
docs/entity-definitions.md
View File

@@ -6,28 +6,28 @@ Targets represent devices or software instances that can receive software update
**Filterable/Sortable Fields:**
| Field | Description | Type |
|------------------------------------|----------------------------------------------------------------------|------|
| `controllerId` | Unique identifier of the target | String |
| `name` | Display name | String |
| `description` | Description text | String |
| `updateStatus` | Current update status (UNKNOWN, IN_SYNC, PENDING, ERROR, REGISTERED) | Enum |
| `address` | IP address or URI | String |
| `lastTargetQuery` | Last time the target polled (timestamp in ms) | Long |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| `assignedDistributionSet.name` | Name of assigned distribution set | String |
| `assignedDistributionSet.version` | Version of assigned distribution set | String |
| `installedDistributionSet.name` | Name of installed distribution set | String |
| `installedDistributionSet.version` | Version of installed distribution set | String |
| `targetType.key` | Target type key | String |
| `targetType.name` | Target type name | String |
| `tags.name` | Tag name | String |
| `group` | Group name | String |
| `metadata.<key>` | Metadata value by key | String |
| `controllerAttributes.<key>` | Controller attribute by key | String |
| Field | Description | Type |
|----------------------------------|----------------------------------------------------------------------|------|
| controllerId | Unique identifier of the target | String |
| name | Display name | String |
| description | Description text | String |
| updateStatus | Current update status (UNKNOWN, IN_SYNC, PENDING, ERROR, REGISTERED) | Enum |
| address | IP address or URI | String |
| lastTargetQuery | Last time the target polled (timestamp in ms) | Long |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
| assignedDistributionSet.name | Name of assigned distribution set | String |
| assignedDistributionSet.version | Version of assigned distribution set | String |
| installedDistributionSet.name | Name of installed distribution set | String |
| installedDistributionSet.version | Version of installed distribution set | String |
| targetType.key | Target type key | String |
| targetType.name | Target type name | String |
| tags.name | Tag name | String |
| group | Group name | String |
| metadata.<key> | Metadata value by key | String |
| controllerAttributes.<key> | Controller attribute by key | String |
**Example Queries:**
```
@@ -63,20 +63,20 @@ Distribution Sets are collections of software modules that can be deployed to ta
| Field | Description | Type |
|-------|-------------|------|
| `id` | Unique identifier | Long |
| `name` | Distribution set name | String |
| `version` | Version string | String |
| `description` | Description text | String |
| `type.key` | Distribution set type key | String |
| `type.name` | Distribution set type name | String |
| `valid` | Whether the DS is valid for deployment | Boolean |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| `tags.name` | Tag name | String |
| `modules.name` | Software module name | String |
| `metadata.<key>` | Metadata value by key | String |
| id | Unique identifier | Long |
| name | Distribution set name | String |
| version | Version string | String |
| description | Description text | String |
| type.key | Distribution set type key | String |
| type.name | Distribution set type name | String |
| valid | Whether the DS is valid for deployment | Boolean |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
| tags.name | Tag name | String |
| modules.name | Software module name | String |
| metadata.<key> | Metadata value by key | String |
**Example Queries:**
```
@@ -106,18 +106,18 @@ Rollouts are used to deploy software to groups of targets in a controlled manner
| Field | Description | Type |
|-------|-------------|------|
| `id` | Unique identifier | Long |
| `name` | Rollout name | String |
| `description` | Description text | String |
| `status` | Rollout status (CREATING, READY, PAUSED, STARTING, RUNNING, FINISHED, etc.) | Enum |
| `distributionSet.id` | Distribution set ID | Long |
| `distributionSet.name` | Distribution set name | String |
| `distributionSet.version` | Distribution set version | String |
| `distributionSet.type` | Distribution set type | String |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| id | Unique identifier | Long |
| name | Rollout name | String |
| description | Description text | String |
| status | Rollout status (CREATING, READY, PAUSED, STARTING, RUNNING, FINISHED, etc.) | Enum |
| distributionSet.id | Distribution set ID | Long |
| distributionSet.name | Distribution set name | String |
| distributionSet.version | Distribution set version | String |
| distributionSet.type | Distribution set type | String |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
**Example Queries:**
```
@@ -144,26 +144,26 @@ Actions represent deployment operations assigned to targets.
| Field | Description | Type |
|-------|-------------|------|
| `id` | Unique identifier | Long |
| `status` | Action status (SCHEDULED, RUNNING, FINISHED, ERROR, CANCELED, etc.) | Enum |
| `active` | Whether the action is currently active | Boolean |
| `weight` | Priority weight (0-1000) | Integer |
| `lastActionStatusCode` | Last status code reported | Integer |
| `externalRef` | External reference string | String |
| `target.controllerId` | Target controller ID | String |
| `target.name` | Target name | String |
| `target.updateStatus` | Target update status | Enum |
| `distributionSet.id` | Distribution set ID | Long |
| `distributionSet.name` | Distribution set name | String |
| `distributionSet.version` | Distribution set version | String |
| `rollout.id` | Rollout ID | Long |
| `rollout.name` | Rollout name | String |
| `rolloutGroup.id` | Rollout group ID | Long |
| `rolloutGroup.name` | Rollout group name | String |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| id | Unique identifier | Long |
| status | Action status (SCHEDULED, RUNNING, FINISHED, ERROR, CANCELED, etc.) | Enum |
| active | Whether the action is currently active | Boolean |
| weight | Priority weight (0-1000) | Integer |
| lastActionStatusCode | Last status code reported | Integer |
| externalRef | External reference string | String |
| target.controllerId | Target controller ID | String |
| target.name | Target name | String |
| target.updateStatus | Target update status | Enum |
| distributionSet.id | Distribution set ID | Long |
| distributionSet.name | Distribution set name | String |
| distributionSet.version | Distribution set version | String |
| rollout.id | Rollout ID | Long |
| rollout.name | Rollout name | String |
| rolloutGroup.id | Rollout group ID | Long |
| rolloutGroup.name | Rollout group name | String |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
**Example Queries:**
```
@@ -199,17 +199,17 @@ Software Modules are individual software components that make up distribution se
| Field | Description | Type |
|-------|-------------|------|
| `id` | Unique identifier | Long |
| `name` | Module name | String |
| `version` | Version string | String |
| `description` | Description text | String |
| `type.key` | Software module type key | String |
| `type.name` | Software module type name | String |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| `metadata.<key>` | Metadata value by key | String |
| id | Unique identifier | Long |
| name | Module name | String |
| version | Version string | String |
| description | Description text | String |
| type.key | Software module type key | String |
| type.name | Software module type name | String |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
| metadata.<key> | Metadata value by key | String |
**Example Queries:**
```
@@ -236,14 +236,14 @@ Target Filter Queries define RSQL filters for grouping targets, used for rollout
| Field | Description | Type |
|-------|-------------|------|
| `id` | Unique identifier | Long |
| `name` | Filter name | String |
| `autoAssignDistributionSet.name` | Auto-assign DS name | String |
| `autoAssignDistributionSet.version` | Auto-assign DS version | String |
| `createdAt` | Creation timestamp | Long |
| `createdBy` | Creator username | String |
| `lastModifiedAt` | Last modification timestamp | Long |
| `lastModifiedBy` | Last modifier username | String |
| id | Unique identifier | Long |
| name | Filter name | String |
| autoAssignDistributionSet.name | Auto-assign DS name | String |
| autoAssignDistributionSet.version | Auto-assign DS version | String |
| createdAt | Creation timestamp | Long |
| createdBy | Creator username | String |
| lastModifiedAt | Last modification timestamp | Long |
| lastModifiedBy | Last modifier username | String |
**Example Queries:**
```