Last generated April 25, 2025
GrafanaOrganization
GrafanaOrganization is the Schema describing a Grafana organization. Its lifecycle is managed by the observability-operator.
Version v1alpha1
Example CR
apiVersion: observability.giantswarm.io/v1alpha1
kind: GrafanaOrganization
metadata:
labels:
app.kubernetes.io/name: observability-operator
app.kubernetes.io/managed-by: kustomize
name: grafanaorganization-sample
spec:
displayName: Giant Swarm
rbac:
admins:
- my-awesome-admins
- other-admins
editors:
- my-awesome-editors
- other-editors
viewers:
- my-awesome-viewers
- other-viewers
tenants:
- myawesometenants
Properties
.apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
.kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
.metadata
.spec
GrafanaOrganizationSpec defines the desired state of GrafanaOrganization
.spec.displayName
DisplayName is the name displayed when viewing the organization in Grafana. It can be different from the actual org’s name.
.spec.rbac
Access rules defines user permissions for interacting with the organization in Grafana.
.spec.rbac.admins
Admins is a list of user organizations that have admin access to the grafanaorganization.
.spec.rbac.admins[*]
.spec.rbac.editors
Editors is a list of user organizations that have editor access to the grafanaorganization.
.spec.rbac.editors[*]
.spec.rbac.viewers
Viewers is a list of user organizations that have viewer access to the grafanaorganization.
.spec.rbac.viewers[*]
.spec.tenants
Tenants is a list of tenants that are associated with the Grafana organization.
.spec.tenants[*]
TenantID is a unique identifier for a tenant. It must be lowercase.
.status
GrafanaOrganizationStatus defines the observed state of GrafanaOrganization
.status.dataSources
DataSources is a list of grafana data sources that are available to the Grafana organization.
.status.dataSources[*]
DataSource defines the name and id for data sources.
.status.dataSources[*].ID
ID is the unique id of the data source.
.status.dataSources[*].name
Name is the name of the data source.
.status.orgID
OrgID is the actual organisation ID in grafana.
This documentation page shows information based on observability-operator v0.27.0.
Need help with the platform API?
We listen in your Slack support channel. And of course, we welcome your pull requests to improve these docs!