aiven.v1alpha1.grafana
"Grafana is the Schema for the grafanas API"
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withCloudName(cloudName)
fn withDisk_space(disk_space)
fn withMaintenanceWindowDow(maintenanceWindowDow)
fn withMaintenanceWindowTime(maintenanceWindowTime)
fn withPlan(plan)
fn withProject(project)
fn withProjectVpcId(projectVpcId)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTerminationProtection(terminationProtection)
obj spec.authSecretRef
obj spec.connInfoSecretTarget
obj spec.projectVPCRef
obj spec.userConfig
fn withAdditional_backup_regions(additional_backup_regions)
fn withAdditional_backup_regionsMixin(additional_backup_regions)
fn withAlerting_enabled(alerting_enabled)
fn withAlerting_error_or_timeout(alerting_error_or_timeout)
fn withAlerting_max_annotations_to_keep(alerting_max_annotations_to_keep)
fn withAlerting_nodata_or_nullvalues(alerting_nodata_or_nullvalues)
fn withAllow_embedding(allow_embedding)
fn withAuth_basic_enabled(auth_basic_enabled)
fn withCookie_samesite(cookie_samesite)
fn withCustom_domain(custom_domain)
fn withDashboard_previews_enabled(dashboard_previews_enabled)
fn withDashboards_min_refresh_interval(dashboards_min_refresh_interval)
fn withDashboards_versions_to_keep(dashboards_versions_to_keep)
fn withDataproxy_send_user_header(dataproxy_send_user_header)
fn withDataproxy_timeout(dataproxy_timeout)
fn withDisable_gravatar(disable_gravatar)
fn withEditors_can_admin(editors_can_admin)
fn withGoogle_analytics_ua_id(google_analytics_ua_id)
fn withIp_filter(ip_filter)
fn withIp_filterMixin(ip_filter)
fn withMetrics_enabled(metrics_enabled)
fn withProject_to_fork_from(project_to_fork_from)
fn withRecovery_basebackup_name(recovery_basebackup_name)
fn withService_to_fork_from(service_to_fork_from)
fn withStatic_ips(static_ips)
fn withUser_auto_assign_org(user_auto_assign_org)
fn withUser_auto_assign_org_role(user_auto_assign_org_role)
fn withViewers_can_edit(viewers_can_edit)
obj spec.userConfig.auth_azuread
fn withAllow_sign_up(allow_sign_up)
fn withAllowed_domains(allowed_domains)
fn withAllowed_domainsMixin(allowed_domains)
fn withAllowed_groups(allowed_groups)
fn withAllowed_groupsMixin(allowed_groups)
fn withAuth_url(auth_url)
fn withClient_id(client_id)
fn withClient_secret(client_secret)
fn withToken_url(token_url)
obj spec.userConfig.auth_generic_oauth
fn withAllow_sign_up(allow_sign_up)
fn withAllowed_domains(allowed_domains)
fn withAllowed_domainsMixin(allowed_domains)
fn withAllowed_organizations(allowed_organizations)
fn withAllowed_organizationsMixin(allowed_organizations)
fn withApi_url(api_url)
fn withAuth_url(auth_url)
fn withClient_id(client_id)
fn withClient_secret(client_secret)
fn withName(name)
fn withScopes(scopes)
fn withScopesMixin(scopes)
fn withToken_url(token_url)
obj spec.userConfig.auth_github
obj spec.userConfig.auth_gitlab
obj spec.userConfig.auth_google
obj spec.userConfig.date_formats
obj spec.userConfig.external_image_storage
obj spec.userConfig.ip_filter
obj spec.userConfig.private_access
obj spec.userConfig.privatelink_access
obj spec.userConfig.public_access
obj spec.userConfig.smtp_server
Fields
fn new
new(name)
new returns an instance of Grafana
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"
fn metadata.withSelfLink
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
"GrafanaSpec defines the desired state of Grafana"
fn spec.withCloudName
withCloudName(cloudName)
"Cloud the service runs in."
fn spec.withDisk_space
withDisk_space(disk_space)
"The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service re-balancing."
fn spec.withMaintenanceWindowDow
withMaintenanceWindowDow(maintenanceWindowDow)
"Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc."
fn spec.withMaintenanceWindowTime
withMaintenanceWindowTime(maintenanceWindowTime)
"Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format."
fn spec.withPlan
withPlan(plan)
"Subscription plan."
fn spec.withProject
withProject(project)
"Target project."
fn spec.withProjectVpcId
withProjectVpcId(projectVpcId)
"Identifier of the VPC the service should be in, if any."
fn spec.withTags
withTags(tags)
"Tags are key-value pairs that allow you to categorize services."
fn spec.withTagsMixin
withTagsMixin(tags)
"Tags are key-value pairs that allow you to categorize services."
Note: This function appends passed data to existing values
fn spec.withTerminationProtection
withTerminationProtection(terminationProtection)
"Prevent service from being deleted. It is recommended to have this enabled for all services."
obj spec.authSecretRef
"Authentication reference to Aiven token in a secret"
fn spec.authSecretRef.withKey
withKey(key)
fn spec.authSecretRef.withName
withName(name)
obj spec.connInfoSecretTarget
"Information regarding secret creation"
fn spec.connInfoSecretTarget.withName
withName(name)
"Name of the Secret resource to be created"
obj spec.projectVPCRef
"ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically"
fn spec.projectVPCRef.withName
withName(name)
fn spec.projectVPCRef.withNamespace
withNamespace(namespace)
obj spec.userConfig
"Cassandra specific user configuration options"
fn spec.userConfig.withAdditional_backup_regions
withAdditional_backup_regions(additional_backup_regions)
"AdditionalBackupRegions Additional Cloud Regions for Backup Replication"
fn spec.userConfig.withAdditional_backup_regionsMixin
withAdditional_backup_regionsMixin(additional_backup_regions)
"AdditionalBackupRegions Additional Cloud Regions for Backup Replication"
Note: This function appends passed data to existing values
fn spec.userConfig.withAlerting_enabled
withAlerting_enabled(alerting_enabled)
"AlertingEnabled Enable or disable Grafana alerting functionality"
fn spec.userConfig.withAlerting_error_or_timeout
withAlerting_error_or_timeout(alerting_error_or_timeout)
"AlertingErrorOrTimeout Default error or timeout setting for new alerting rules"
fn spec.userConfig.withAlerting_max_annotations_to_keep
withAlerting_max_annotations_to_keep(alerting_max_annotations_to_keep)
"AlertingMaxAnnotationsToKeep Max number of alert annotations that Grafana stores. 0 (default) keeps all alert annotations."
fn spec.userConfig.withAlerting_nodata_or_nullvalues
withAlerting_nodata_or_nullvalues(alerting_nodata_or_nullvalues)
"AlertingNodataOrNullvalues Default value for 'no data or null values' for new alerting rules"
fn spec.userConfig.withAllow_embedding
withAllow_embedding(allow_embedding)
"AllowEmbedding Allow embedding Grafana dashboards with iframe/frame/object/embed tags. Disabled by default to limit impact of clickjacking"
fn spec.userConfig.withAuth_basic_enabled
withAuth_basic_enabled(auth_basic_enabled)
"AuthBasicEnabled Enable or disable basic authentication form, used by Grafana built-in login"
fn spec.userConfig.withCookie_samesite
withCookie_samesite(cookie_samesite)
"CookieSamesite Cookie SameSite attribute: 'strict' prevents sending cookie for cross-site requests, effectively disabling direct linking from other sites to Grafana. 'lax' is the default value."
fn spec.userConfig.withCustom_domain
withCustom_domain(custom_domain)
"CustomDomain Serve the web frontend using a custom CNAME pointing to the Aiven DNS name"
fn spec.userConfig.withDashboard_previews_enabled
withDashboard_previews_enabled(dashboard_previews_enabled)
"DashboardPreviewsEnabled This feature is new in Grafana 9 and is quite resource intensive. It may cause low-end plans to work more slowly while the dashboard previews are rendering."
fn spec.userConfig.withDashboards_min_refresh_interval
withDashboards_min_refresh_interval(dashboards_min_refresh_interval)
"DashboardsMinRefreshInterval Signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s, 1h"
fn spec.userConfig.withDashboards_versions_to_keep
withDashboards_versions_to_keep(dashboards_versions_to_keep)
"DashboardsVersionsToKeep Dashboard versions to keep per dashboard"
fn spec.userConfig.withDataproxy_send_user_header
withDataproxy_send_user_header(dataproxy_send_user_header)
"DataproxySendUserHeader Send 'X-Grafana-User' header to data source"
fn spec.userConfig.withDataproxy_timeout
withDataproxy_timeout(dataproxy_timeout)
"DataproxyTimeout Timeout for data proxy requests in seconds"
fn spec.userConfig.withDisable_gravatar
withDisable_gravatar(disable_gravatar)
"DisableGravatar Set to true to disable gravatar. Defaults to false (gravatar is enabled)"
fn spec.userConfig.withEditors_can_admin
withEditors_can_admin(editors_can_admin)
"EditorsCanAdmin Editors can manage folders, teams and dashboards created by them"
fn spec.userConfig.withGoogle_analytics_ua_id
withGoogle_analytics_ua_id(google_analytics_ua_id)
"GoogleAnalyticsUaId Google Analytics ID"
fn spec.userConfig.withIp_filter
withIp_filter(ip_filter)
"IpFilter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'"
fn spec.userConfig.withIp_filterMixin
withIp_filterMixin(ip_filter)
"IpFilter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'"
Note: This function appends passed data to existing values
fn spec.userConfig.withMetrics_enabled
withMetrics_enabled(metrics_enabled)
"MetricsEnabled Enable Grafana /metrics endpoint"
fn spec.userConfig.withProject_to_fork_from
withProject_to_fork_from(project_to_fork_from)
"ProjectToForkFrom Name of another project to fork a service from. This has effect only when a new service is being created."
fn spec.userConfig.withRecovery_basebackup_name
withRecovery_basebackup_name(recovery_basebackup_name)
"RecoveryBasebackupName Name of the basebackup to restore in forked service"
fn spec.userConfig.withService_to_fork_from
withService_to_fork_from(service_to_fork_from)
"ServiceToForkFrom Name of another service to fork from. This has effect only when a new service is being created."
fn spec.userConfig.withStatic_ips
withStatic_ips(static_ips)
"StaticIps Use static public IP addresses"
fn spec.userConfig.withUser_auto_assign_org
withUser_auto_assign_org(user_auto_assign_org)
"UserAutoAssignOrg Auto-assign new users on signup to main organization. Defaults to false"
fn spec.userConfig.withUser_auto_assign_org_role
withUser_auto_assign_org_role(user_auto_assign_org_role)
"UserAutoAssignOrgRole Set role for new signups. Defaults to Viewer"
fn spec.userConfig.withViewers_can_edit
withViewers_can_edit(viewers_can_edit)
"ViewersCanEdit Users with view-only permission can edit but not save dashboards"
obj spec.userConfig.auth_azuread
"AuthAzuread Azure AD OAuth integration"
fn spec.userConfig.auth_azuread.withAllow_sign_up
withAllow_sign_up(allow_sign_up)
"AllowSignUp Automatically sign-up users on successful sign-in"
fn spec.userConfig.auth_azuread.withAllowed_domains
withAllowed_domains(allowed_domains)
"AllowedDomains Allowed domains"
fn spec.userConfig.auth_azuread.withAllowed_domainsMixin
withAllowed_domainsMixin(allowed_domains)
"AllowedDomains Allowed domains"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_azuread.withAllowed_groups
withAllowed_groups(allowed_groups)
"AllowedGroups Require users to belong to one of given groups"
fn spec.userConfig.auth_azuread.withAllowed_groupsMixin
withAllowed_groupsMixin(allowed_groups)
"AllowedGroups Require users to belong to one of given groups"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_azuread.withAuth_url
withAuth_url(auth_url)
"AuthUrl Authorization URL"
fn spec.userConfig.auth_azuread.withClient_id
withClient_id(client_id)
"ClientId Client ID from provider"
fn spec.userConfig.auth_azuread.withClient_secret
withClient_secret(client_secret)
"ClientSecret Client secret from provider"
fn spec.userConfig.auth_azuread.withToken_url
withToken_url(token_url)
"TokenUrl Token URL"
obj spec.userConfig.auth_generic_oauth
"AuthGenericOauth Generic OAuth integration"
fn spec.userConfig.auth_generic_oauth.withAllow_sign_up
withAllow_sign_up(allow_sign_up)
"AllowSignUp Automatically sign-up users on successful sign-in"
fn spec.userConfig.auth_generic_oauth.withAllowed_domains
withAllowed_domains(allowed_domains)
"AllowedDomains Allowed domains"
fn spec.userConfig.auth_generic_oauth.withAllowed_domainsMixin
withAllowed_domainsMixin(allowed_domains)
"AllowedDomains Allowed domains"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_generic_oauth.withAllowed_organizations
withAllowed_organizations(allowed_organizations)
"AllowedOrganizations Require user to be member of one of the listed organizations"
fn spec.userConfig.auth_generic_oauth.withAllowed_organizationsMixin
withAllowed_organizationsMixin(allowed_organizations)
"AllowedOrganizations Require user to be member of one of the listed organizations"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_generic_oauth.withApi_url
withApi_url(api_url)
"ApiUrl API URL"
fn spec.userConfig.auth_generic_oauth.withAuth_url
withAuth_url(auth_url)
"AuthUrl Authorization URL"
fn spec.userConfig.auth_generic_oauth.withClient_id
withClient_id(client_id)
"ClientId Client ID from provider"
fn spec.userConfig.auth_generic_oauth.withClient_secret
withClient_secret(client_secret)
"ClientSecret Client secret from provider"
fn spec.userConfig.auth_generic_oauth.withName
withName(name)
"Name of the OAuth integration"
fn spec.userConfig.auth_generic_oauth.withScopes
withScopes(scopes)
"Scopes OAuth scopes"
fn spec.userConfig.auth_generic_oauth.withScopesMixin
withScopesMixin(scopes)
"Scopes OAuth scopes"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_generic_oauth.withToken_url
withToken_url(token_url)
"TokenUrl Token URL"
obj spec.userConfig.auth_github
"AuthGithub Github Auth integration"
fn spec.userConfig.auth_github.withAllow_sign_up
withAllow_sign_up(allow_sign_up)
"AllowSignUp Automatically sign-up users on successful sign-in"
fn spec.userConfig.auth_github.withAllowed_organizations
withAllowed_organizations(allowed_organizations)
"AllowedOrganizations Require users to belong to one of given organizations"
fn spec.userConfig.auth_github.withAllowed_organizationsMixin
withAllowed_organizationsMixin(allowed_organizations)
"AllowedOrganizations Require users to belong to one of given organizations"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_github.withClient_id
withClient_id(client_id)
"ClientId Client ID from provider"
fn spec.userConfig.auth_github.withClient_secret
withClient_secret(client_secret)
"ClientSecret Client secret from provider"
fn spec.userConfig.auth_github.withTeam_ids
withTeam_ids(team_ids)
"TeamIds Require users to belong to one of given team IDs"
fn spec.userConfig.auth_github.withTeam_idsMixin
withTeam_idsMixin(team_ids)
"TeamIds Require users to belong to one of given team IDs"
Note: This function appends passed data to existing values
obj spec.userConfig.auth_gitlab
"AuthGitlab GitLab Auth integration"
fn spec.userConfig.auth_gitlab.withAllow_sign_up
withAllow_sign_up(allow_sign_up)
"AllowSignUp Automatically sign-up users on successful sign-in"
fn spec.userConfig.auth_gitlab.withAllowed_groups
withAllowed_groups(allowed_groups)
"AllowedGroups Require users to belong to one of given groups"
fn spec.userConfig.auth_gitlab.withAllowed_groupsMixin
withAllowed_groupsMixin(allowed_groups)
"AllowedGroups Require users to belong to one of given groups"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_gitlab.withApi_url
withApi_url(api_url)
"ApiUrl API URL. This only needs to be set when using self hosted GitLab"
fn spec.userConfig.auth_gitlab.withAuth_url
withAuth_url(auth_url)
"AuthUrl Authorization URL. This only needs to be set when using self hosted GitLab"
fn spec.userConfig.auth_gitlab.withClient_id
withClient_id(client_id)
"ClientId Client ID from provider"
fn spec.userConfig.auth_gitlab.withClient_secret
withClient_secret(client_secret)
"ClientSecret Client secret from provider"
fn spec.userConfig.auth_gitlab.withToken_url
withToken_url(token_url)
"TokenUrl Token URL. This only needs to be set when using self hosted GitLab"
obj spec.userConfig.auth_google
"AuthGoogle Google Auth integration"
fn spec.userConfig.auth_google.withAllow_sign_up
withAllow_sign_up(allow_sign_up)
"AllowSignUp Automatically sign-up users on successful sign-in"
fn spec.userConfig.auth_google.withAllowed_domains
withAllowed_domains(allowed_domains)
"AllowedDomains Domains allowed to sign-in to this Grafana"
fn spec.userConfig.auth_google.withAllowed_domainsMixin
withAllowed_domainsMixin(allowed_domains)
"AllowedDomains Domains allowed to sign-in to this Grafana"
Note: This function appends passed data to existing values
fn spec.userConfig.auth_google.withClient_id
withClient_id(client_id)
"ClientId Client ID from provider"
fn spec.userConfig.auth_google.withClient_secret
withClient_secret(client_secret)
"ClientSecret Client secret from provider"
obj spec.userConfig.date_formats
"DateFormats Grafana date format specifications"
fn spec.userConfig.date_formats.withDefault_timezone
withDefault_timezone(default_timezone)
"DefaultTimezone Default time zone for user preferences. Value 'browser' uses browser local time zone."
fn spec.userConfig.date_formats.withFull_date
withFull_date(full_date)
"FullDate Moment.js style format string for cases where full date is shown"
fn spec.userConfig.date_formats.withInterval_day
withInterval_day(interval_day)
"IntervalDay Moment.js style format string used when a time requiring day accuracy is shown"
fn spec.userConfig.date_formats.withInterval_hour
withInterval_hour(interval_hour)
"IntervalHour Moment.js style format string used when a time requiring hour accuracy is shown"
fn spec.userConfig.date_formats.withInterval_minute
withInterval_minute(interval_minute)
"IntervalMinute Moment.js style format string used when a time requiring minute accuracy is shown"
fn spec.userConfig.date_formats.withInterval_month
withInterval_month(interval_month)
"IntervalMonth Moment.js style format string used when a time requiring month accuracy is shown"
fn spec.userConfig.date_formats.withInterval_second
withInterval_second(interval_second)
"IntervalSecond Moment.js style format string used when a time requiring second accuracy is shown"
fn spec.userConfig.date_formats.withInterval_year
withInterval_year(interval_year)
"IntervalYear Moment.js style format string used when a time requiring year accuracy is shown"
obj spec.userConfig.external_image_storage
"ExternalImageStorage External image store settings"
fn spec.userConfig.external_image_storage.withAccess_key
withAccess_key(access_key)
"AccessKey S3 access key. Requires permissions to the S3 bucket for the s3:PutObject and s3:PutObjectAcl actions"
fn spec.userConfig.external_image_storage.withBucket_url
withBucket_url(bucket_url)
"BucketUrl Bucket URL for S3"
fn spec.userConfig.external_image_storage.withProvider
withProvider(provider)
"Provider type"
fn spec.userConfig.external_image_storage.withSecret_key
withSecret_key(secret_key)
"SecretKey S3 secret key"
obj spec.userConfig.ip_filter
"IpFilter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'"
fn spec.userConfig.ip_filter.withDescription
withDescription(description)
"Description for IP filter list entry"
fn spec.userConfig.ip_filter.withNetwork
withNetwork(network)
"Network CIDR address block"
obj spec.userConfig.private_access
"PrivateAccess Allow access to selected service ports from private networks"
fn spec.userConfig.private_access.withGrafana
withGrafana(grafana)
"Grafana Allow clients to connect to grafana with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations"
obj spec.userConfig.privatelink_access
"PrivatelinkAccess Allow access to selected service components through Privatelink"
fn spec.userConfig.privatelink_access.withGrafana
withGrafana(grafana)
"Grafana Enable grafana"
obj spec.userConfig.public_access
"PublicAccess Allow access to selected service ports from the public Internet"
fn spec.userConfig.public_access.withGrafana
withGrafana(grafana)
"Grafana Allow clients to connect to grafana from the public internet for service nodes that are in a project VPC or another type of private network"
obj spec.userConfig.smtp_server
"SmtpServer SMTP server settings"
fn spec.userConfig.smtp_server.withFrom_address
withFrom_address(from_address)
"FromAddress Address used for sending emails"
fn spec.userConfig.smtp_server.withFrom_name
withFrom_name(from_name)
"FromName Name used in outgoing emails, defaults to Grafana"
fn spec.userConfig.smtp_server.withHost
withHost(host)
"Host Server hostname or IP"
fn spec.userConfig.smtp_server.withPassword
withPassword(password)
"Password for SMTP authentication"
fn spec.userConfig.smtp_server.withPort
withPort(port)
"Port SMTP server port"
fn spec.userConfig.smtp_server.withSkip_verify
withSkip_verify(skip_verify)
"SkipVerify Skip verifying server certificate. Defaults to false"
fn spec.userConfig.smtp_server.withStarttls_policy
withStarttls_policy(starttls_policy)
"StarttlsPolicy Either OpportunisticStartTLS, MandatoryStartTLS or NoStartTLS. Default is OpportunisticStartTLS."
fn spec.userConfig.smtp_server.withUsername
withUsername(username)
"Username for SMTP authentication"