Skip to content

[doc] Fix Kubernetes resources documentation #430

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
Sep 16, 2022
Merged

[doc] Fix Kubernetes resources documentation #430

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
8 changes: 4 additions & 4 deletions docs/resources/kubernetes-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ kobs supports all Kubernetes objects like Pods, Deployments, StatefulSets and Cu
!!! note
Ensure that the satellite has enough permissions to retrieve all these resources from the Kubernetes API server. If you are using the [Helm chart](../getting-started/installation//helm.md) or [Kustomize](../getting-started/installation/kustomize.md) to install kobs, it will automatically create the correct Cluster Role and Cluster Role Binding, so that you can view, but not edit all these resources.

On the Kubernetes Resources page in kobs you can view all the resources available in you clusters. You can filter the list by clusters, namespaces and resources. You can also specify a label or field selector.
On the Kubernetes Resources page in kobs you can view all the resources available in your clusters. You can filter the list by clusters, namespaces and resources. You can also specify a label or field selector.

![Resources](assets/resources.png)

By selecting an item in the table, you can view more details for this resource. All the details can be found in the overview tab.
By selecting an item in the table, you can view more details for this resource. All the details can be found in the "Overview" tab.

![Resources Overview](assets/resources-overview.png)

If you want to view the Yaml representation of the resource you can select the corresponding tab.

![Resources YAML](assets/resources-yaml.png)

Next to the yaml representation, you find a second tab events, which shows all events, which are related to the selected object. The events are retrieved with a field selector and the name of the resource: `fieldSelector=involvedObject.name=<NAME-OF-THE-RESOURCE>`.
Next to the yaml representation, you find a second tab "Events", which shows all events, which are related to the selected object. The events are retrieved with a field selector and the name of the resource: `fieldSelector=involvedObject.name=<NAME-OF-THE-RESOURCE>`.

![Resources Events](assets/resources-events.png)

Expand All @@ -41,7 +41,7 @@ You can specify a list of dashboards for your Kubernetes resources, to get addit

The dashboards can be configured via the `kobs.io/dashboards` annotation. They follow the same syntax as they can be configured for [applications](applications.md#dashboard), [users](teams.md#dashboard) and [teams](teams.md#dashboard).

You can use [JSONPath](https://goessner.net/articles/JsonPath/) within the dashboar dspecification, to use a value from the reosurce manifest in the dashboard, e.g. the name of the Pod `<% $.metadata.name %>`.
You can use [JSONPath](https://goessner.net/articles/JsonPath/) within the dashboard specification, to use a value from the resource manifest in the dashboard, e.g. the name of the Pod `<% $.metadata.name %>`.

!!! note
We are using the [jsonpath-plus](https://www.npmjs.com/package/jsonpath-plus) to extract the content from the Kubernetes objects. A list of examples can be found within the documentation of the module.
Expand Down