Kubernetes Labels
Understand the Kubernetes labels used by Ryvn for observability and management
Ryvn applies a set of standardized Kubernetes labels to all resources it manages. These labels help with observability, management, and troubleshooting by providing consistent metadata across your deployments.
Core Labels
All Ryvn-managed resources include the following labels:
Label | Description | Example |
---|---|---|
ryvn.app/service-name | The name of the service | my-api |
app.kubernetes.io/managed-by | Indicates that Ryvn manages this resource | ryvn |
app.kubernetes.io/instance | The name of the installation | my-api-production |
app.kubernetes.io/name | The component name | web-server |
app.kubernetes.io/version | The version of the application | 1.2.3 |
ryvn.app/release-version | The specific release version deployed | 1.2.3 |
Using Labels for Observability
These labels are particularly useful when:
-
Filtering resources in Kubernetes dashboards - You can use these labels to filter and group resources in tools like Kubernetes Dashboard, Lens, or k9s.
-
Setting up monitoring tools - Configure monitoring tools like Prometheus to collect metrics based on these labels.
-
Debugging deployments - Quickly identify which version of your application is running in each environment.
-
Creating custom views - Build custom dashboards that group resources by service, version, or other attributes.
Example: Filtering by Release Version
If you have access to your Kubernetes cluster, you can use the ryvn.app/release-version
label to find all resources
running a specific version:
This will return all pods running version 1.2.3 of your application.
Example: Monitoring Version Distribution
You can use these labels to monitor the distribution of versions across your environments, which is particularly useful during rolling updates:
This will show all pods for the my-api
service along with their labels, including which version each pod is running.
Integration with External Tools
Many observability tools support Kubernetes label-based filtering and grouping:
- Prometheus: Use label selectors in your scrape configurations
- Grafana: Create dashboards that filter metrics by service and version
- Datadog: Filter and group resources by Kubernetes labels
- New Relic: Use labels for filtering and creating custom views
The specific labels available may vary slightly depending on the service type (Server, Worker, Job, Chart, or Terraform).