Skip to content

Specify Dashboards within Teams and Applications #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 31, 2021
Merged

Specify Dashboards within Teams and Applications #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ NOTE: As semantic versioning states all 0.y.z releases can contain breaking chan
- [#124](https://github.com/kobsio/kobs/pull/124): Add `sql` mode for ClickHouse to execute raw SQL queries.
- [#126](https://github.com/kobsio/kobs/pull/126): Show request details when gettings logs from ClickHouse.
- [#127](https://github.com/kobsio/kobs/pull/127): Allow `ILIKE` queries for ClickHouse logs, using the new `=~` operator.
- [#128](https://github.com/kobsio/kobs/pull/128): Allow users to specify dashboards within a Team or Application via the new `inline` property.

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion deploy/helm/kobs/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ description: Kubernetes Observability Platform
type: application
home: https://kobs.io
icon: https://kobs.io/assets/images/logo.svg
version: 0.5.4
version: 0.6.0
appVersion: v0.5.0
70 changes: 69 additions & 1 deletion deploy/helm/kobs/crds/kobs.io_applications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,75 @@ spec:
type: string
description:
type: string
inline:
properties:
rows:
items:
properties:
description:
type: string
panels:
items:
properties:
colSpan:
format: int64
type: integer
description:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
rowSpan:
format: int64
type: integer
title:
type: string
required:
- plugin
- title
type: object
type: array
size:
format: int64
type: integer
title:
type: string
required:
- panels
type: object
type: array
variables:
items:
properties:
hide:
type: boolean
label:
type: string
name:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
required:
- name
- plugin
type: object
type: array
required:
- rows
type: object
name:
type: string
namespace:
Expand All @@ -55,7 +124,6 @@ spec:
title:
type: string
required:
- name
- title
type: object
type: array
Expand Down
70 changes: 69 additions & 1 deletion deploy/helm/kobs/crds/kobs.io_teams.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,75 @@ spec:
type: string
description:
type: string
inline:
properties:
rows:
items:
properties:
description:
type: string
panels:
items:
properties:
colSpan:
format: int64
type: integer
description:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
rowSpan:
format: int64
type: integer
title:
type: string
required:
- plugin
- title
type: object
type: array
size:
format: int64
type: integer
title:
type: string
required:
- panels
type: object
type: array
variables:
items:
properties:
hide:
type: boolean
label:
type: string
name:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
required:
- name
- plugin
type: object
type: array
required:
- rows
type: object
name:
type: string
namespace:
Expand All @@ -55,7 +124,6 @@ spec:
title:
type: string
required:
- name
- title
type: object
type: array
Expand Down
70 changes: 69 additions & 1 deletion deploy/kustomize/crds/kobs.io_applications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,75 @@ spec:
type: string
description:
type: string
inline:
properties:
rows:
items:
properties:
description:
type: string
panels:
items:
properties:
colSpan:
format: int64
type: integer
description:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
rowSpan:
format: int64
type: integer
title:
type: string
required:
- plugin
- title
type: object
type: array
size:
format: int64
type: integer
title:
type: string
required:
- panels
type: object
type: array
variables:
items:
properties:
hide:
type: boolean
label:
type: string
name:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
required:
- name
- plugin
type: object
type: array
required:
- rows
type: object
name:
type: string
namespace:
Expand All @@ -55,7 +124,6 @@ spec:
title:
type: string
required:
- name
- title
type: object
type: array
Expand Down
70 changes: 69 additions & 1 deletion deploy/kustomize/crds/kobs.io_teams.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,75 @@ spec:
type: string
description:
type: string
inline:
properties:
rows:
items:
properties:
description:
type: string
panels:
items:
properties:
colSpan:
format: int64
type: integer
description:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
rowSpan:
format: int64
type: integer
title:
type: string
required:
- plugin
- title
type: object
type: array
size:
format: int64
type: integer
title:
type: string
required:
- panels
type: object
type: array
variables:
items:
properties:
hide:
type: boolean
label:
type: string
name:
type: string
plugin:
properties:
name:
type: string
options:
x-kubernetes-preserve-unknown-fields: true
required:
- name
type: object
required:
- name
- plugin
type: object
type: array
required:
- rows
type: object
name:
type: string
namespace:
Expand All @@ -55,7 +124,6 @@ spec:
title:
type: string
required:
- name
- title
type: object
type: array
Expand Down
10 changes: 9 additions & 1 deletion docs/resources/applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,18 @@ Define the dashboards, which should be used for the application.
| ----- | ---- | ----------- | -------- |
| cluster | string | Cluster of the dashboard. If this field is omitted kobs will look in the same cluster as the application was created in. | No |
| namespace | string | Namespace of the dashboard. If this field is omitted kobs will look in the same namespace as the application was created in. | No |
| name | string | Name of the dashboard. | Yes |
| name | string | Name of the dashboard. **Note:** You have not to provide a name, if you use the **inline** property. | Yes |
| title | string | Title for the dashboard | Yes |
| description | string | The description can be used to explain the content of the dashboard. | No |
| placeholders | map<string, string> | A map of placeholders, whith the name as key and the value for the placeholder as value. More information for placeholders can be found in the documentation for [Dashboards](./dashboards.md). | No |
| inline | [Inline](#inline) | Specify a complete dashboard within the reference. This can be used if you just use the dashboard within one application. | No |

### Inline

| Field | Type | Description | Required |
| ----- | ---- | ----------- | -------- |
| variables | [[]Variable](./dashboards.md#Variable) | A list of variables, where the values are loaded by the specified plugin. | No |
| rows | [[]Row](./dashboards.md#row) | A list of rows for the dashboard. | Yes |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dashboards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In the following you can found the specification for the Dashboard CRD. On the b
| description | string | Provide a descriptions for the dashboard with additional details. | No |
| placeholders | [[]Placeholder](#placeholder) | A list of placeholders, which can be directly set by the user. | No |
| variables | [[]Variable](#Variable) | A list of variables, where the values are loaded by the specified plugin. | No |
| Rows | [[]Row](#row) | A list of rows for the dashboard. | Yes |
| rows | [[]Row](#row) | A list of rows for the dashboard. | Yes |

### Placeholder

Expand Down
10 changes: 9 additions & 1 deletion docs/resources/teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,18 @@ Define the dashboards, which should be used for the team.
| ----- | ---- | ----------- | -------- |
| cluster | string | Cluster of the dashboard. If this field is omitted kobs will look in the same cluster as the application was created in. | No |
| namespace | string | Namespace of the dashboard. If this field is omitted kobs will look in the same namespace as the application was created in. | No |
| name | string | Name of the dashboard. | Yes |
| name | string | Name of the dashboard. **Note:** You have not to provide a name, if you use the **inline** property. | Yes |
| title | string | Title for the dashboard | Yes |
| description | string | The description can be used to explain the content of the dashboard. | No |
| placeholders | map<string, string> | A map of placeholders, whith the name as key and the value for the placeholder as value. More information for placeholders can be found in the documentation for [Dashboards](./dashboards.md). | No |
| inline | [Inline](#inline) | Specify a complete dashboard within the reference. This can be used if you just use the dashboard within one team. | No |

### Inline

| Field | Type | Description | Required |
| ----- | ---- | ----------- | -------- |
| variables | [[]Variable](./dashboards.md#Variable) | A list of variables, where the values are loaded by the specified plugin. | No |
| rows | [[]Row](./dashboards.md#row) | A list of rows for the dashboard. | Yes |

## Example

Expand Down
Loading