Skip to content

integreatly.v1alpha1.grafanaDataSource

"GrafanaDataSource is the Schema for the grafanadatasources API"

Index

Fields

fn new

new(name)

new returns an instance of GrafanaDataSource

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"GrafanaDataSourceSpec defines the desired state of GrafanaDataSource"

fn spec.withDatasources

withDatasources(datasources)

fn spec.withDatasourcesMixin

withDatasourcesMixin(datasources)

Note: This function appends passed data to existing values

fn spec.withName

withName(name)

obj spec.datasources

fn spec.datasources.withAccess

withAccess(access)

fn spec.datasources.withBasicAuth

withBasicAuth(basicAuth)

fn spec.datasources.withBasicAuthPassword

withBasicAuthPassword(basicAuthPassword)

fn spec.datasources.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

fn spec.datasources.withDatabase

withDatabase(database)

fn spec.datasources.withEditable

withEditable(editable)

fn spec.datasources.withIsDefault

withIsDefault(isDefault)

fn spec.datasources.withName

withName(name)

fn spec.datasources.withOrgId

withOrgId(orgId)

fn spec.datasources.withPassword

withPassword(password)

fn spec.datasources.withType

withType(type)

fn spec.datasources.withUid

withUid(uid)

fn spec.datasources.withUrl

withUrl(url)

fn spec.datasources.withUser

withUser(user)

fn spec.datasources.withVersion

withVersion(version)

fn spec.datasources.withWithCredentials

withWithCredentials(withCredentials)

obj spec.datasources.jsonData

"GrafanaDataSourceJsonData contains the most common json options See https://grafana.com/docs/administration/provisioning/#datasources"

fn spec.datasources.jsonData.withAddCorsHeader

withAddCorsHeader(addCorsHeader)

"Useful fields for clickhouse datasource See https://github.com/Vertamedia/clickhouse-grafana/tree/master/dist/README.md#configure-the-datasource-with-provisioning See https://github.com/Vertamedia/clickhouse-grafana/tree/master/src/datasource.ts#L44"

fn spec.datasources.jsonData.withAllowInfraExplore

withAllowInfraExplore(allowInfraExplore)

fn spec.datasources.jsonData.withApiToken

withApiToken(apiToken)

fn spec.datasources.jsonData.withAppInsightsAppId

withAppInsightsAppId(appInsightsAppId)

"Fields for Azure data sources"

fn spec.datasources.jsonData.withAssumeRoleArn

withAssumeRoleArn(assumeRoleArn)

fn spec.datasources.jsonData.withAuthType

withAuthType(authType)

fn spec.datasources.jsonData.withAuthenticationType

withAuthenticationType(authenticationType)

fn spec.datasources.jsonData.withAzureLogAnalyticsSameAs

withAzureLogAnalyticsSameAs(azureLogAnalyticsSameAs)

fn spec.datasources.jsonData.withClientEmail

withClientEmail(clientEmail)

fn spec.datasources.jsonData.withClientId

withClientId(clientId)

fn spec.datasources.jsonData.withCloudName

withCloudName(cloudName)

fn spec.datasources.jsonData.withClusterUrl

withClusterUrl(clusterUrl)

fn spec.datasources.jsonData.withConnMaxLifetime

withConnMaxLifetime(connMaxLifetime)

fn spec.datasources.jsonData.withCustomMetricsNamespaces

withCustomMetricsNamespaces(customMetricsNamespaces)

fn spec.datasources.jsonData.withCustomQueryParameters

withCustomQueryParameters(customQueryParameters)

"Fields for Prometheus data sources"

fn spec.datasources.jsonData.withDefaultBucket

withDefaultBucket(defaultBucket)

fn spec.datasources.jsonData.withDefaultDatabase

withDefaultDatabase(defaultDatabase)

fn spec.datasources.jsonData.withDefaultProject

withDefaultProject(defaultProject)

fn spec.datasources.jsonData.withDefaultRegion

withDefaultRegion(defaultRegion)

fn spec.datasources.jsonData.withDerivedFields

withDerivedFields(derivedFields)

fn spec.datasources.jsonData.withDerivedFieldsMixin

withDerivedFieldsMixin(derivedFields)

Note: This function appends passed data to existing values

fn spec.datasources.jsonData.withEncrypt

withEncrypt(encrypt)

fn spec.datasources.jsonData.withEsVersion

withEsVersion(esVersion)

fn spec.datasources.jsonData.withExemplarTraceIdDestinations

withExemplarTraceIdDestinations(exemplarTraceIdDestinations)

fn spec.datasources.jsonData.withExemplarTraceIdDestinationsMixin

withExemplarTraceIdDestinationsMixin(exemplarTraceIdDestinations)

Note: This function appends passed data to existing values

fn spec.datasources.jsonData.withGithubUrl

withGithubUrl(githubUrl)

"Fields for Github data sources"

fn spec.datasources.jsonData.withGraphiteVersion

withGraphiteVersion(graphiteVersion)

fn spec.datasources.jsonData.withHttpHeaderName1

withHttpHeaderName1(httpHeaderName1)

"Custom HTTP headers for datasources See https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources"

fn spec.datasources.jsonData.withHttpHeaderName2

withHttpHeaderName2(httpHeaderName2)

fn spec.datasources.jsonData.withHttpHeaderName3

withHttpHeaderName3(httpHeaderName3)

fn spec.datasources.jsonData.withHttpHeaderName4

withHttpHeaderName4(httpHeaderName4)

fn spec.datasources.jsonData.withHttpHeaderName5

withHttpHeaderName5(httpHeaderName5)

fn spec.datasources.jsonData.withHttpHeaderName6

withHttpHeaderName6(httpHeaderName6)

fn spec.datasources.jsonData.withHttpHeaderName7

withHttpHeaderName7(httpHeaderName7)

fn spec.datasources.jsonData.withHttpHeaderName8

withHttpHeaderName8(httpHeaderName8)

fn spec.datasources.jsonData.withHttpHeaderName9

withHttpHeaderName9(httpHeaderName9)

fn spec.datasources.jsonData.withHttpMethod

withHttpMethod(httpMethod)

fn spec.datasources.jsonData.withHttpMode

withHttpMode(httpMode)

"Fields for InfluxDB data sources"

fn spec.datasources.jsonData.withImplementation

withImplementation(implementation)

"Fields for Alertmanager data sources"

fn spec.datasources.jsonData.withInterval

withInterval(interval)

fn spec.datasources.jsonData.withLogAnalyticsClientId

withLogAnalyticsClientId(logAnalyticsClientId)

fn spec.datasources.jsonData.withLogAnalyticsDefaultWorkspace

withLogAnalyticsDefaultWorkspace(logAnalyticsDefaultWorkspace)

fn spec.datasources.jsonData.withLogAnalyticsSubscriptionId

withLogAnalyticsSubscriptionId(logAnalyticsSubscriptionId)

fn spec.datasources.jsonData.withLogAnalyticsTenantId

withLogAnalyticsTenantId(logAnalyticsTenantId)

fn spec.datasources.jsonData.withLogLevelField

withLogLevelField(logLevelField)

fn spec.datasources.jsonData.withLogMessageField

withLogMessageField(logMessageField)

fn spec.datasources.jsonData.withMaxIdleConns

withMaxIdleConns(maxIdleConns)

fn spec.datasources.jsonData.withMaxLines

withMaxLines(maxLines)

"Fields for Loki data sources"

fn spec.datasources.jsonData.withMaxOpenConns

withMaxOpenConns(maxOpenConns)

fn spec.datasources.jsonData.withOauthPassThru

withOauthPassThru(oauthPassThru)

fn spec.datasources.jsonData.withOrganization

withOrganization(organization)

fn spec.datasources.jsonData.withPostgresVersion

withPostgresVersion(postgresVersion)

fn spec.datasources.jsonData.withShowOffline

withShowOffline(showOffline)

fn spec.datasources.jsonData.withSigV4AssumeRoleArn

withSigV4AssumeRoleArn(sigV4AssumeRoleArn)

fn spec.datasources.jsonData.withSigV4Auth

withSigV4Auth(sigV4Auth)

"Fields for AWS Prometheus data sources"

fn spec.datasources.jsonData.withSigV4AuthType

withSigV4AuthType(sigV4AuthType)

fn spec.datasources.jsonData.withSigV4ExternalId

withSigV4ExternalId(sigV4ExternalId)

fn spec.datasources.jsonData.withSigV4Profile

withSigV4Profile(sigV4Profile)

fn spec.datasources.jsonData.withSigV4Region

withSigV4Region(sigV4Region)

fn spec.datasources.jsonData.withSslmode

withSslmode(sslmode)

fn spec.datasources.jsonData.withSubscriptionId

withSubscriptionId(subscriptionId)

fn spec.datasources.jsonData.withTenantId

withTenantId(tenantId)

fn spec.datasources.jsonData.withTimeField

withTimeField(timeField)

fn spec.datasources.jsonData.withTimeInterval

withTimeInterval(timeInterval)

fn spec.datasources.jsonData.withTimescaledb

withTimescaledb(timescaledb)

fn spec.datasources.jsonData.withTlsAuth

withTlsAuth(tlsAuth)

fn spec.datasources.jsonData.withTlsAuthWithCACert

withTlsAuthWithCACert(tlsAuthWithCACert)

fn spec.datasources.jsonData.withTlsSkipVerify

withTlsSkipVerify(tlsSkipVerify)

fn spec.datasources.jsonData.withTokenUri

withTokenUri(tokenUri)

"Fields for Stackdriver data sources"

fn spec.datasources.jsonData.withTsdbResolution

withTsdbResolution(tsdbResolution)

fn spec.datasources.jsonData.withTsdbVersion

withTsdbVersion(tsdbVersion)

fn spec.datasources.jsonData.withUrl

withUrl(url)

"Fields for Instana data sources See https://github.com/instana/instana-grafana-datasource/blob/main/provisioning/datasources/datasource.yml"

fn spec.datasources.jsonData.withUsePOST

withUsePOST(usePOST)

fn spec.datasources.jsonData.withUseProxy

withUseProxy(useProxy)

fn spec.datasources.jsonData.withUseYandexCloudAuthorization

withUseYandexCloudAuthorization(useYandexCloudAuthorization)

fn spec.datasources.jsonData.withVersion

withVersion(version)

fn spec.datasources.jsonData.withXHeaderKey

withXHeaderKey(xHeaderKey)

fn spec.datasources.jsonData.withXHeaderUser

withXHeaderUser(xHeaderUser)

obj spec.datasources.jsonData.derivedFields

fn spec.datasources.jsonData.derivedFields.withDatasourceUid

withDatasourceUid(datasourceUid)

fn spec.datasources.jsonData.derivedFields.withMatcherRegex

withMatcherRegex(matcherRegex)

fn spec.datasources.jsonData.derivedFields.withName

withName(name)

fn spec.datasources.jsonData.derivedFields.withUrl

withUrl(url)

obj spec.datasources.jsonData.exemplarTraceIdDestinations

fn spec.datasources.jsonData.exemplarTraceIdDestinations.withDatasourceUid

withDatasourceUid(datasourceUid)

fn spec.datasources.jsonData.exemplarTraceIdDestinations.withName

withName(name)

fn spec.datasources.jsonData.exemplarTraceIdDestinations.withUrl

withUrl(url)

fn spec.datasources.jsonData.exemplarTraceIdDestinations.withUrlDisplayLabel

withUrlDisplayLabel(urlDisplayLabel)

obj spec.datasources.jsonData.nodeGraph

fn spec.datasources.jsonData.nodeGraph.withEnabled

withEnabled(enabled)

obj spec.datasources.jsonData.search

fn spec.datasources.jsonData.search.withHide

withHide(hide)

obj spec.datasources.jsonData.serviceMap

fn spec.datasources.jsonData.serviceMap.withDatasourceUid

withDatasourceUid(datasourceUid)

obj spec.datasources.jsonData.tracesToLogs

"Fields for tracing data sources"

fn spec.datasources.jsonData.tracesToLogs.withDatasourceUid

withDatasourceUid(datasourceUid)

fn spec.datasources.jsonData.tracesToLogs.withFilterBySpanID

withFilterBySpanID(filterBySpanID)

fn spec.datasources.jsonData.tracesToLogs.withFilterByTraceID

withFilterByTraceID(filterByTraceID)

fn spec.datasources.jsonData.tracesToLogs.withLokiSearch

withLokiSearch(lokiSearch)

fn spec.datasources.jsonData.tracesToLogs.withSpanEndTimeShift

withSpanEndTimeShift(spanEndTimeShift)

fn spec.datasources.jsonData.tracesToLogs.withSpanStartTimeShift

withSpanStartTimeShift(spanStartTimeShift)

fn spec.datasources.jsonData.tracesToLogs.withTags

withTags(tags)

fn spec.datasources.jsonData.tracesToLogs.withTagsMixin

withTagsMixin(tags)

Note: This function appends passed data to existing values

obj spec.datasources.secureJsonData

"GrafanaDataSourceSecureJsonData contains the most common secure json options See https://grafana.com/docs/administration/provisioning/#datasources"

fn spec.datasources.secureJsonData.withAccessKey

withAccessKey(accessKey)

fn spec.datasources.secureJsonData.withAccessToken

withAccessToken(accessToken)

"Fields for Github data sources"

fn spec.datasources.secureJsonData.withAppInsightsApiKey

withAppInsightsApiKey(appInsightsApiKey)

fn spec.datasources.secureJsonData.withBasicAuthPassword

withBasicAuthPassword(basicAuthPassword)

fn spec.datasources.secureJsonData.withClientSecret

withClientSecret(clientSecret)

"Fields for Azure data sources"

fn spec.datasources.secureJsonData.withHttpHeaderValue1

withHttpHeaderValue1(httpHeaderValue1)

"Custom HTTP headers for datasources See https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources"

fn spec.datasources.secureJsonData.withHttpHeaderValue2

withHttpHeaderValue2(httpHeaderValue2)

fn spec.datasources.secureJsonData.withHttpHeaderValue3

withHttpHeaderValue3(httpHeaderValue3)

fn spec.datasources.secureJsonData.withHttpHeaderValue4

withHttpHeaderValue4(httpHeaderValue4)

fn spec.datasources.secureJsonData.withHttpHeaderValue5

withHttpHeaderValue5(httpHeaderValue5)

fn spec.datasources.secureJsonData.withHttpHeaderValue6

withHttpHeaderValue6(httpHeaderValue6)

fn spec.datasources.secureJsonData.withHttpHeaderValue7

withHttpHeaderValue7(httpHeaderValue7)

fn spec.datasources.secureJsonData.withHttpHeaderValue8

withHttpHeaderValue8(httpHeaderValue8)

fn spec.datasources.secureJsonData.withHttpHeaderValue9

withHttpHeaderValue9(httpHeaderValue9)

fn spec.datasources.secureJsonData.withLogAnalyticsClientSecret

withLogAnalyticsClientSecret(logAnalyticsClientSecret)

fn spec.datasources.secureJsonData.withPassword

withPassword(password)

fn spec.datasources.secureJsonData.withPrivateKey

withPrivateKey(privateKey)

"Fields for Stackdriver data sources"

fn spec.datasources.secureJsonData.withSecretKey

withSecretKey(secretKey)

fn spec.datasources.secureJsonData.withSigV4AccessKey

withSigV4AccessKey(sigV4AccessKey)

"Fields for AWS data sources"

fn spec.datasources.secureJsonData.withSigV4SecretKey

withSigV4SecretKey(sigV4SecretKey)

fn spec.datasources.secureJsonData.withTlsCACert

withTlsCACert(tlsCACert)

fn spec.datasources.secureJsonData.withTlsClientCert

withTlsClientCert(tlsClientCert)

fn spec.datasources.secureJsonData.withTlsClientKey

withTlsClientKey(tlsClientKey)

fn spec.datasources.secureJsonData.withToken

withToken(token)

"Fields for InfluxDB data sources"