diff --git a/Makefile b/Makefile index 73253d3..fd25edf 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ -LIBRARY_VERSION:=0.0.3 -PROVIDER_VERSION:=0.18.0 +LIBRARY_VERSION:=0.0.4 +PROVIDER_VERSION:=0.21.0 JSONNET_BIN:=jrsonnet VENDOR_DEPTHS:=$(shell find generator/vendor -type f) diff --git a/docs/README.md b/docs/README.md index afeb30e..d3b3470 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ Jsonnet library providing a namespaced set of compositions/XRDs for the Grafana ## Install ``` -jb install github.com/Duologic/grafana-crossplane-libsonnet/grafanaplane@0.0.3-0.18.0 +jb install github.com/Duologic/grafana-crossplane-libsonnet/grafanaplane@0.0.4-0.21.0 ``` ## Usage diff --git a/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/forProvider/rule/index.md b/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/forProvider/rule/index.md index aa3ab26..86c02d3 100644 --- a/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/forProvider/rule/index.md +++ b/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/forProvider/rule/index.md @@ -36,8 +36,8 @@ PARAMETERS: * **value** (`object`) -value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. -Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. +value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. +Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. ### fn withAnnotationsMixin ```jsonnet @@ -48,8 +48,8 @@ PARAMETERS: * **value** (`object`) -value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. -Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. +value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. +Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. ### fn withCondition ```jsonnet diff --git a/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/initProvider/rule/index.md b/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/initProvider/rule/index.md index aa3ab26..86c02d3 100644 --- a/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/initProvider/rule/index.md +++ b/docs/raw/alerting/v1alpha1/ruleGroup/spec/parameters/initProvider/rule/index.md @@ -36,8 +36,8 @@ PARAMETERS: * **value** (`object`) -value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. -Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. +value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. +Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. ### fn withAnnotationsMixin ```jsonnet @@ -48,8 +48,8 @@ PARAMETERS: * **value** (`object`) -value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. -Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. +value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. +Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. ### fn withCondition ```jsonnet diff --git a/docs/raw/oncall/v1alpha1/escalation.md b/docs/raw/oncall/v1alpha1/escalation.md index 9e8b9ed..5861ba6 100644 --- a/docs/raw/oncall/v1alpha1/escalation.md +++ b/docs/raw/oncall/v1alpha1/escalation.md @@ -94,6 +94,7 @@ * [`fn withPersonsToNotifyNextEachTime(value)`](#fn-specparametersforproviderwithpersonstonotifynexteachtime) * [`fn withPersonsToNotifyNextEachTimeMixin(value)`](#fn-specparametersforproviderwithpersonstonotifynexteachtimemixin) * [`fn withPosition(value)`](#fn-specparametersforproviderwithposition) + * [`fn withSeverity(value)`](#fn-specparametersforproviderwithseverity) * [`fn withType(value)`](#fn-specparametersforproviderwithtype) * [`obj actionToTriggerRef`](#obj-specparametersforprovideractiontotriggerref) * [`fn withName(value)`](#fn-specparametersforprovideractiontotriggerrefwithname) @@ -170,6 +171,7 @@ * [`fn withPersonsToNotifyNextEachTime(value)`](#fn-specparametersinitproviderwithpersonstonotifynexteachtime) * [`fn withPersonsToNotifyNextEachTimeMixin(value)`](#fn-specparametersinitproviderwithpersonstonotifynexteachtimemixin) * [`fn withPosition(value)`](#fn-specparametersinitproviderwithposition) + * [`fn withSeverity(value)`](#fn-specparametersinitproviderwithseverity) * [`fn withType(value)`](#fn-specparametersinitproviderwithtype) * [`obj actionToTriggerRef`](#obj-specparametersinitprovideractiontotriggerref) * [`fn withName(value)`](#fn-specparametersinitprovideractiontotriggerrefwithname) @@ -1057,8 +1059,8 @@ PARAMETERS: * **value** (`number`) -(Number) The duration of delay for wait type step. -The duration of delay for wait type step. +86400) seconds +The duration of delay for wait type step. (60-86400) seconds ###### fn spec.parameters.forProvider.withEscalationChainId ```jsonnet @@ -1292,6 +1294,18 @@ PARAMETERS: (Number) The position of the escalation step (starts from 0). The position of the escalation step (starts from 0). +###### fn spec.parameters.forProvider.withSeverity + +```jsonnet +spec.parameters.forProvider.withSeverity(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The severity of the incident for declare_incident type step. +The severity of the incident for declare_incident type step. ###### fn spec.parameters.forProvider.withType ```jsonnet @@ -1302,8 +1316,8 @@ PARAMETERS: * **value** (`string`) -(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members -The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members +(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident +The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident ###### obj spec.parameters.forProvider.actionToTriggerRef @@ -1865,8 +1879,8 @@ PARAMETERS: * **value** (`number`) -(Number) The duration of delay for wait type step. -The duration of delay for wait type step. +86400) seconds +The duration of delay for wait type step. (60-86400) seconds ###### fn spec.parameters.initProvider.withEscalationChainId ```jsonnet @@ -2100,6 +2114,18 @@ PARAMETERS: (Number) The position of the escalation step (starts from 0). The position of the escalation step (starts from 0). +###### fn spec.parameters.initProvider.withSeverity + +```jsonnet +spec.parameters.initProvider.withSeverity(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The severity of the incident for declare_incident type step. +The severity of the incident for declare_incident type step. ###### fn spec.parameters.initProvider.withType ```jsonnet @@ -2110,8 +2136,8 @@ PARAMETERS: * **value** (`string`) -(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members -The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members +(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident +The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident ###### obj spec.parameters.initProvider.actionToTriggerRef diff --git a/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/index.md b/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/index.md index 04d61fa..b40828b 100644 --- a/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/index.md +++ b/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/index.md @@ -6,6 +6,7 @@ * [email](email.md) * [microsoftTeams](microsoftTeams.md) +* [mobileApp](mobileApp.md) * [phoneCall](phoneCall.md) * [slack](slack.md) * [sms](sms.md) @@ -20,6 +21,8 @@ * [`fn withGroupingKey(value)`](#fn-withgroupingkey) * [`fn withMicrosoftTeams(value)`](#fn-withmicrosoftteams) * [`fn withMicrosoftTeamsMixin(value)`](#fn-withmicrosoftteamsmixin) +* [`fn withMobileApp(value)`](#fn-withmobileapp) +* [`fn withMobileAppMixin(value)`](#fn-withmobileappmixin) * [`fn withPhoneCall(value)`](#fn-withphonecall) * [`fn withPhoneCallMixin(value)`](#fn-withphonecallmixin) * [`fn withResolveSignal(value)`](#fn-withresolvesignal) @@ -93,8 +96,8 @@ PARAMETERS: * **value** (`array`) -(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) -Templates for Microsoft Teams. +(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) +Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. ### fn withMicrosoftTeamsMixin ```jsonnet @@ -105,8 +108,32 @@ PARAMETERS: * **value** (`array`) -(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) -Templates for Microsoft Teams. +(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) +Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. +### fn withMobileApp + +```jsonnet +withMobileApp(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) +Templates for Mobile app push notifications. +### fn withMobileAppMixin + +```jsonnet +withMobileAppMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) +Templates for Mobile app push notifications. ### fn withPhoneCall ```jsonnet diff --git a/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/mobileApp.md b/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/mobileApp.md new file mode 100644 index 0000000..58619d3 --- /dev/null +++ b/docs/raw/oncall/v1alpha1/integration/spec/parameters/forProvider/templates/mobileApp.md @@ -0,0 +1,35 @@ +# mobileApp + + + +## Index + +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withMessage + +```jsonnet +withMessage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert message. +Template for Alert message. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert title. +Template for Alert title. \ No newline at end of file diff --git a/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/index.md b/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/index.md index 04d61fa..b40828b 100644 --- a/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/index.md +++ b/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/index.md @@ -6,6 +6,7 @@ * [email](email.md) * [microsoftTeams](microsoftTeams.md) +* [mobileApp](mobileApp.md) * [phoneCall](phoneCall.md) * [slack](slack.md) * [sms](sms.md) @@ -20,6 +21,8 @@ * [`fn withGroupingKey(value)`](#fn-withgroupingkey) * [`fn withMicrosoftTeams(value)`](#fn-withmicrosoftteams) * [`fn withMicrosoftTeamsMixin(value)`](#fn-withmicrosoftteamsmixin) +* [`fn withMobileApp(value)`](#fn-withmobileapp) +* [`fn withMobileAppMixin(value)`](#fn-withmobileappmixin) * [`fn withPhoneCall(value)`](#fn-withphonecall) * [`fn withPhoneCallMixin(value)`](#fn-withphonecallmixin) * [`fn withResolveSignal(value)`](#fn-withresolvesignal) @@ -93,8 +96,8 @@ PARAMETERS: * **value** (`array`) -(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) -Templates for Microsoft Teams. +(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) +Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. ### fn withMicrosoftTeamsMixin ```jsonnet @@ -105,8 +108,32 @@ PARAMETERS: * **value** (`array`) -(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) -Templates for Microsoft Teams. +(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) +Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. +### fn withMobileApp + +```jsonnet +withMobileApp(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) +Templates for Mobile app push notifications. +### fn withMobileAppMixin + +```jsonnet +withMobileAppMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) +Templates for Mobile app push notifications. ### fn withPhoneCall ```jsonnet diff --git a/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/mobileApp.md b/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/mobileApp.md new file mode 100644 index 0000000..58619d3 --- /dev/null +++ b/docs/raw/oncall/v1alpha1/integration/spec/parameters/initProvider/templates/mobileApp.md @@ -0,0 +1,35 @@ +# mobileApp + + + +## Index + +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withMessage + +```jsonnet +withMessage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert message. +Template for Alert message. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert title. +Template for Alert title. \ No newline at end of file diff --git a/docs/raw/oncall/v1alpha1/onCallShift.md b/docs/raw/oncall/v1alpha1/onCallShift.md index 2ed7a13..414b25c 100644 --- a/docs/raw/oncall/v1alpha1/onCallShift.md +++ b/docs/raw/oncall/v1alpha1/onCallShift.md @@ -86,6 +86,7 @@ * [`fn withTeamId(value)`](#fn-specparametersforproviderwithteamid) * [`fn withTimeZone(value)`](#fn-specparametersforproviderwithtimezone) * [`fn withType(value)`](#fn-specparametersforproviderwithtype) + * [`fn withUntil(value)`](#fn-specparametersforproviderwithuntil) * [`fn withUsers(value)`](#fn-specparametersforproviderwithusers) * [`fn withUsersMixin(value)`](#fn-specparametersforproviderwithusersmixin) * [`fn withWeekStart(value)`](#fn-specparametersforproviderwithweekstart) @@ -108,6 +109,7 @@ * [`fn withTeamId(value)`](#fn-specparametersinitproviderwithteamid) * [`fn withTimeZone(value)`](#fn-specparametersinitproviderwithtimezone) * [`fn withType(value)`](#fn-specparametersinitproviderwithtype) + * [`fn withUntil(value)`](#fn-specparametersinitproviderwithuntil) * [`fn withUsers(value)`](#fn-specparametersinitproviderwithusers) * [`fn withUsersMixin(value)`](#fn-specparametersinitproviderwithusersmixin) * [`fn withWeekStart(value)`](#fn-specparametersinitproviderwithweekstart) @@ -1099,6 +1101,18 @@ PARAMETERS: (String) The shift's type. Can be rolling_users, recurrent_event, single_event The shift's type. Can be rolling_users, recurrent_event, single_event +###### fn spec.parameters.forProvider.withUntil + +```jsonnet +spec.parameters.forProvider.withUntil(value) +``` + +PARAMETERS: + +* **value** (`string`) + +call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") +The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") ###### fn spec.parameters.forProvider.withUsers ```jsonnet @@ -1354,6 +1368,18 @@ PARAMETERS: (String) The shift's type. Can be rolling_users, recurrent_event, single_event The shift's type. Can be rolling_users, recurrent_event, single_event +###### fn spec.parameters.initProvider.withUntil + +```jsonnet +spec.parameters.initProvider.withUntil(value) +``` + +PARAMETERS: + +* **value** (`string`) + +call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") +The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") ###### fn spec.parameters.initProvider.withUsers ```jsonnet diff --git a/docs/raw/oss/v1alpha1/ssoSettings/index.md b/docs/raw/oss/v1alpha1/ssoSettings/index.md index b080a03..286df96 100644 --- a/docs/raw/oss/v1alpha1/ssoSettings/index.md +++ b/docs/raw/oss/v1alpha1/ssoSettings/index.md @@ -4,8 +4,10 @@ ## Subpackages +* [spec.parameters.forProvider.ldapSettings](spec/parameters/forProvider/ldapSettings/index.md) * [spec.parameters.forProvider.oauth2Settings](spec/parameters/forProvider/oauth2Settings.md) * [spec.parameters.forProvider.samlSettings](spec/parameters/forProvider/samlSettings.md) +* [spec.parameters.initProvider.ldapSettings](spec/parameters/initProvider/ldapSettings/index.md) * [spec.parameters.initProvider.oauth2Settings](spec/parameters/initProvider/oauth2Settings.md) * [spec.parameters.initProvider.samlSettings](spec/parameters/initProvider/samlSettings.md) @@ -75,12 +77,16 @@ * [`fn withWriteConnectionSecretToRef(value)`](#fn-specparameterswithwriteconnectionsecrettoref) * [`fn withWriteConnectionSecretToRefMixin(value)`](#fn-specparameterswithwriteconnectionsecrettorefmixin) * [`obj forProvider`](#obj-specparametersforprovider) + * [`fn withLdapSettings(value)`](#fn-specparametersforproviderwithldapsettings) + * [`fn withLdapSettingsMixin(value)`](#fn-specparametersforproviderwithldapsettingsmixin) * [`fn withOauth2Settings(value)`](#fn-specparametersforproviderwithoauth2settings) * [`fn withOauth2SettingsMixin(value)`](#fn-specparametersforproviderwithoauth2settingsmixin) * [`fn withProviderName(value)`](#fn-specparametersforproviderwithprovidername) * [`fn withSamlSettings(value)`](#fn-specparametersforproviderwithsamlsettings) * [`fn withSamlSettingsMixin(value)`](#fn-specparametersforproviderwithsamlsettingsmixin) * [`obj initProvider`](#obj-specparametersinitprovider) + * [`fn withLdapSettings(value)`](#fn-specparametersinitproviderwithldapsettings) + * [`fn withLdapSettingsMixin(value)`](#fn-specparametersinitproviderwithldapsettingsmixin) * [`fn withOauth2Settings(value)`](#fn-specparametersinitproviderwithoauth2settings) * [`fn withOauth2SettingsMixin(value)`](#fn-specparametersinitproviderwithoauth2settingsmixin) * [`fn withProviderName(value)`](#fn-specparametersinitproviderwithprovidername) @@ -858,6 +864,30 @@ each other. ##### obj spec.parameters.forProvider +###### fn spec.parameters.forProvider.withLdapSettings + +```jsonnet +spec.parameters.forProvider.withLdapSettings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) +The LDAP settings set. Required for the ldap provider. +###### fn spec.parameters.forProvider.withLdapSettingsMixin + +```jsonnet +spec.parameters.forProvider.withLdapSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) +The LDAP settings set. Required for the ldap provider. ###### fn spec.parameters.forProvider.withOauth2Settings ```jsonnet @@ -892,8 +922,8 @@ PARAMETERS: * **value** (`string`) -(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. -The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. +(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. +The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. ###### fn spec.parameters.forProvider.withSamlSettings ```jsonnet @@ -921,6 +951,30 @@ The SAML settings set. Required for the saml provider. ##### obj spec.parameters.initProvider +###### fn spec.parameters.initProvider.withLdapSettings + +```jsonnet +spec.parameters.initProvider.withLdapSettings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) +The LDAP settings set. Required for the ldap provider. +###### fn spec.parameters.initProvider.withLdapSettingsMixin + +```jsonnet +spec.parameters.initProvider.withLdapSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) +The LDAP settings set. Required for the ldap provider. ###### fn spec.parameters.initProvider.withOauth2Settings ```jsonnet @@ -955,8 +1009,8 @@ PARAMETERS: * **value** (`string`) -(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. -The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. +(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. +The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. ###### fn spec.parameters.initProvider.withSamlSettings ```jsonnet diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/index.md new file mode 100644 index 0000000..5d71649 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/index.md @@ -0,0 +1,39 @@ +# config + + + +## Subpackages + +* [servers](servers/index.md) + +## Index + +* [`fn withServers(value)`](#fn-withservers) +* [`fn withServersMixin(value)`](#fn-withserversmixin) + +## Fields + +### fn withServers + +```jsonnet +withServers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) +The LDAP servers configuration. +### fn withServersMixin + +```jsonnet +withServersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) +The LDAP servers configuration. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/groupMappings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/groupMappings.md new file mode 100644 index 0000000..6bfd273 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/groupMappings.md @@ -0,0 +1,62 @@ +# groupMappings + + + +## Index + +* [`fn withGrafanaAdmin(value=true)`](#fn-withgrafanaadmin) +* [`fn withGroupDn(value)`](#fn-withgroupdn) +* [`fn withOrgId(value)`](#fn-withorgid) +* [`fn withOrgRole(value)`](#fn-withorgrole) + +## Fields + +### fn withGrafanaAdmin + +```jsonnet +withGrafanaAdmin(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, it makes the user of group_dn Grafana server admin. +If set to true, it makes the user of group_dn Grafana server admin. +### fn withGroupDn + +```jsonnet +withGroupDn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). +LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). +### fn withOrgId + +```jsonnet +withOrgId(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The Grafana organization database id. +The Grafana organization database id. +### fn withOrgRole + +```jsonnet +withOrgRole(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Assign users of group_dn the organization role Admin, Editor, or Viewer. +Assign users of group_dn the organization role Admin, Editor, or Viewer. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/index.md new file mode 100644 index 0000000..63ce99d --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/config/servers/index.md @@ -0,0 +1,552 @@ +# servers + + + +## Subpackages + +* [groupMappings](groupMappings.md) + +## Index + +* [`fn withAttributes(value)`](#fn-withattributes) +* [`fn withAttributesMixin(value)`](#fn-withattributesmixin) +* [`fn withBindDn(value)`](#fn-withbinddn) +* [`fn withBindPasswordSecretRef(value)`](#fn-withbindpasswordsecretref) +* [`fn withBindPasswordSecretRefMixin(value)`](#fn-withbindpasswordsecretrefmixin) +* [`fn withClientCert(value)`](#fn-withclientcert) +* [`fn withClientCertValue(value)`](#fn-withclientcertvalue) +* [`fn withClientKeySecretRef(value)`](#fn-withclientkeysecretref) +* [`fn withClientKeySecretRefMixin(value)`](#fn-withclientkeysecretrefmixin) +* [`fn withClientKeyValueSecretRef(value)`](#fn-withclientkeyvaluesecretref) +* [`fn withClientKeyValueSecretRefMixin(value)`](#fn-withclientkeyvaluesecretrefmixin) +* [`fn withGroupMappings(value)`](#fn-withgroupmappings) +* [`fn withGroupMappingsMixin(value)`](#fn-withgroupmappingsmixin) +* [`fn withGroupSearchBaseDns(value)`](#fn-withgroupsearchbasedns) +* [`fn withGroupSearchBaseDnsMixin(value)`](#fn-withgroupsearchbasednsmixin) +* [`fn withGroupSearchFilter(value)`](#fn-withgroupsearchfilter) +* [`fn withGroupSearchFilterUserAttribute(value)`](#fn-withgroupsearchfilteruserattribute) +* [`fn withHost(value)`](#fn-withhost) +* [`fn withMinTlsVersion(value)`](#fn-withmintlsversion) +* [`fn withPort(value)`](#fn-withport) +* [`fn withRootCaCert(value)`](#fn-withrootcacert) +* [`fn withRootCaCertValue(value)`](#fn-withrootcacertvalue) +* [`fn withRootCaCertValueMixin(value)`](#fn-withrootcacertvaluemixin) +* [`fn withSearchBaseDns(value)`](#fn-withsearchbasedns) +* [`fn withSearchBaseDnsMixin(value)`](#fn-withsearchbasednsmixin) +* [`fn withSearchFilter(value)`](#fn-withsearchfilter) +* [`fn withSslSkipVerify(value=true)`](#fn-withsslskipverify) +* [`fn withStartTls(value=true)`](#fn-withstarttls) +* [`fn withTimeout(value)`](#fn-withtimeout) +* [`fn withTlsCiphers(value)`](#fn-withtlsciphers) +* [`fn withTlsCiphersMixin(value)`](#fn-withtlsciphersmixin) +* [`fn withUseSsl(value=true)`](#fn-withusessl) +* [`obj bindPasswordSecretRef`](#obj-bindpasswordsecretref) + * [`fn withKey(value)`](#fn-bindpasswordsecretrefwithkey) + * [`fn withName(value)`](#fn-bindpasswordsecretrefwithname) + * [`fn withNamespace(value)`](#fn-bindpasswordsecretrefwithnamespace) +* [`obj clientKeySecretRef`](#obj-clientkeysecretref) + * [`fn withKey(value)`](#fn-clientkeysecretrefwithkey) + * [`fn withName(value)`](#fn-clientkeysecretrefwithname) + * [`fn withNamespace(value)`](#fn-clientkeysecretrefwithnamespace) +* [`obj clientKeyValueSecretRef`](#obj-clientkeyvaluesecretref) + * [`fn withKey(value)`](#fn-clientkeyvaluesecretrefwithkey) + * [`fn withName(value)`](#fn-clientkeyvaluesecretrefwithname) + * [`fn withNamespace(value)`](#fn-clientkeyvaluesecretrefwithnamespace) + +## Fields + +### fn withAttributes + +```jsonnet +withAttributes(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +### fn withAttributesMixin + +```jsonnet +withAttributesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +### fn withBindDn + +```jsonnet +withBindDn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The search user bind DN. +The search user bind DN. +### fn withBindPasswordSecretRef + +```jsonnet +withBindPasswordSecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The search user bind password. +The search user bind password. +### fn withBindPasswordSecretRefMixin + +```jsonnet +withBindPasswordSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The search user bind password. +The search user bind password. +### fn withClientCert + +```jsonnet +withClientCert(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The path to the client certificate. +The path to the client certificate. +### fn withClientCertValue + +```jsonnet +withClientCertValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The Base64 encoded value of the client certificate. +The Base64 encoded value of the client certificate. +### fn withClientKeySecretRef + +```jsonnet +withClientKeySecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The path to the client private key. +The path to the client private key. +### fn withClientKeySecretRefMixin + +```jsonnet +withClientKeySecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The path to the client private key. +The path to the client private key. +### fn withClientKeyValueSecretRef + +```jsonnet +withClientKeyValueSecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The Base64 encoded value of the client private key. +The Base64 encoded value of the client private key. +### fn withClientKeyValueSecretRefMixin + +```jsonnet +withClientKeyValueSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The Base64 encoded value of the client private key. +The Base64 encoded value of the client private key. +### fn withGroupMappings + +```jsonnet +withGroupMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) +For mapping an LDAP group to a Grafana organization and role. +### fn withGroupMappingsMixin + +```jsonnet +withGroupMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) +For mapping an LDAP group to a Grafana organization and role. +### fn withGroupSearchBaseDns + +```jsonnet +withGroupSearchBaseDns(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. +An array of the base DNs to search through for groups. Typically uses ou=groups. +### fn withGroupSearchBaseDnsMixin + +```jsonnet +withGroupSearchBaseDnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. +An array of the base DNs to search through for groups. Typically uses ou=groups. +### fn withGroupSearchFilter + +```jsonnet +withGroupSearchFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). +Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). +### fn withGroupSearchFilterUserAttribute + +```jsonnet +withGroupSearchFilterUserAttribute(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The %s in the search filter will be replaced with the attribute defined in this field. +The %s in the search filter will be replaced with the attribute defined in this field. +### fn withHost + +```jsonnet +withHost(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The LDAP server host. +The LDAP server host. +### fn withMinTlsVersion + +```jsonnet +withMinTlsVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. +Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. +### fn withPort + +```jsonnet +withPort(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The LDAP server port. +The LDAP server port. +### fn withRootCaCert + +```jsonnet +withRootCaCert(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The path to the root CA certificate. +The path to the root CA certificate. +### fn withRootCaCertValue + +```jsonnet +withRootCaCertValue(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) The Base64 encoded values of the root CA certificates. +The Base64 encoded values of the root CA certificates. +### fn withRootCaCertValueMixin + +```jsonnet +withRootCaCertValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) The Base64 encoded values of the root CA certificates. +The Base64 encoded values of the root CA certificates. +### fn withSearchBaseDns + +```jsonnet +withSearchBaseDns(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of base DNs to search through. +An array of base DNs to search through. +### fn withSearchBaseDnsMixin + +```jsonnet +withSearchBaseDnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of base DNs to search through. +An array of base DNs to search through. +### fn withSearchFilter + +```jsonnet +withSearchFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". +The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". +### fn withSslSkipVerify + +```jsonnet +withSslSkipVerify(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, the SSL cert validation will be skipped. +If set to true, the SSL cert validation will be skipped. +### fn withStartTls + +```jsonnet +withStartTls(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS. +If set to true, use LDAP with STARTTLS instead of LDAPS. +### fn withTimeout + +```jsonnet +withTimeout(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The timeout in seconds for connecting to the LDAP host. +The timeout in seconds for connecting to the LDAP host. +### fn withTlsCiphers + +```jsonnet +withTlsCiphers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +### fn withTlsCiphersMixin + +```jsonnet +withTlsCiphersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +### fn withUseSsl + +```jsonnet +withUseSsl(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). +Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). +### obj bindPasswordSecretRef + + +#### fn bindPasswordSecretRef.withKey + +```jsonnet +bindPasswordSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn bindPasswordSecretRef.withName + +```jsonnet +bindPasswordSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn bindPasswordSecretRef.withNamespace + +```jsonnet +bindPasswordSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. +### obj clientKeySecretRef + + +#### fn clientKeySecretRef.withKey + +```jsonnet +clientKeySecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn clientKeySecretRef.withName + +```jsonnet +clientKeySecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn clientKeySecretRef.withNamespace + +```jsonnet +clientKeySecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. +### obj clientKeyValueSecretRef + + +#### fn clientKeyValueSecretRef.withKey + +```jsonnet +clientKeyValueSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn clientKeyValueSecretRef.withName + +```jsonnet +clientKeyValueSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn clientKeyValueSecretRef.withNamespace + +```jsonnet +clientKeyValueSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/index.md new file mode 100644 index 0000000..4ddab01 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/ldapSettings/index.md @@ -0,0 +1,81 @@ +# ldapSettings + + + +## Subpackages + +* [config](config/index.md) + +## Index + +* [`fn withAllowSignUp(value=true)`](#fn-withallowsignup) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withSkipOrgRoleSync(value=true)`](#fn-withskiporgrolesync) + +## Fields + +### fn withAllowSignUp + +```jsonnet +withAllowSignUp(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. +Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) +The LDAP configuration. +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) +The LDAP configuration. +### fn withEnabled + +```jsonnet +withEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. +Define whether this configuration is enabled for LDAP. Defaults to `true`. +### fn withSkipOrgRoleSync + +```jsonnet +withSkipOrgRoleSync(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Prevent synchronizing users’ organization roles from LDAP. +Prevent synchronizing users’ organization roles from LDAP. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/oauth2Settings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/oauth2Settings.md index 5a6c54c..9953fc9 100644 --- a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/oauth2Settings.md +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/oauth2Settings.md @@ -29,6 +29,8 @@ * [`fn withLoginAttributePath(value)`](#fn-withloginattributepath) * [`fn withName(value)`](#fn-withname) * [`fn withNameAttributePath(value)`](#fn-withnameattributepath) +* [`fn withOrgAttributePath(value)`](#fn-withorgattributepath) +* [`fn withOrgMapping(value)`](#fn-withorgmapping) * [`fn withRoleAttributePath(value)`](#fn-withroleattributepath) * [`fn withRoleAttributeStrict(value=true)`](#fn-withroleattributestrict) * [`fn withScopes(value)`](#fn-withscopes) @@ -75,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) If not enabled, only existing Grafana users can log in using OAuth. +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. If not enabled, only existing Grafana users can log in using OAuth. ### fn withAllowedDomains @@ -296,7 +298,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for the specified provider. Defaults to `true`. ### fn withGroupsAttributePath @@ -358,6 +360,30 @@ PARAMETERS: (String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. +### fn withOrgAttributePath + +```jsonnet +withOrgAttributePath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. +JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. +### fn withOrgMapping + +```jsonnet +withOrgMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + +or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. +List of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. ### fn withRoleAttributePath ```jsonnet @@ -418,7 +444,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Prevent synchronizing users’ organization roles from your IdP. +(Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. ### fn withTeamIds diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/samlSettings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/samlSettings.md index c3797e2..4fd0ef5 100644 --- a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/samlSettings.md +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/forProvider/samlSettings.md @@ -17,7 +17,10 @@ * [`fn withCertificatePath(value)`](#fn-withcertificatepath) * [`fn withCertificateSecretRef(value)`](#fn-withcertificatesecretref) * [`fn withCertificateSecretRefMixin(value)`](#fn-withcertificatesecretrefmixin) +* [`fn withClientId(value)`](#fn-withclientid) +* [`fn withClientSecret(value)`](#fn-withclientsecret) * [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withForceUseGraphApi(value=true)`](#fn-withforceusegraphapi) * [`fn withIdpMetadata(value)`](#fn-withidpmetadata) * [`fn withIdpMetadataPath(value)`](#fn-withidpmetadatapath) * [`fn withIdpMetadataUrl(value)`](#fn-withidpmetadataurl) @@ -38,6 +41,7 @@ * [`fn withSignatureAlgorithm(value)`](#fn-withsignaturealgorithm) * [`fn withSingleLogout(value=true)`](#fn-withsinglelogout) * [`fn withSkipOrgRoleSync(value=true)`](#fn-withskiporgrolesync) +* [`fn withTokenUrl(value)`](#fn-withtokenurl) * [`obj certificateSecretRef`](#obj-certificatesecretref) * [`fn withKey(value)`](#fn-certificatesecretrefwithkey) * [`fn withName(value)`](#fn-certificatesecretrefwithname) @@ -73,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) If not enabled, only existing Grafana users can log in using OAuth. +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. Whether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML. ### fn withAllowedOrganizations @@ -208,6 +212,30 @@ PARAMETERS: encoded string for the SP X.509 certificate. Base64-encoded string for the SP X.509 certificate. +### fn withClientId + +```jsonnet +withClientId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The client Id of your OAuth2 app. +The client Id of your OAuth2 app. +### fn withClientSecret + +```jsonnet +withClientSecret(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String, Sensitive) The client secret of your OAuth2 app. +The client secret of your OAuth2 app. ### fn withEnabled ```jsonnet @@ -219,8 +247,21 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for SAML. Defaults to `true`. +### fn withForceUseGraphApi + +```jsonnet +withForceUseGraphApi(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. +If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. ### fn withIdpMetadata ```jsonnet @@ -315,7 +356,7 @@ PARAMETERS: * **value** (`string`) -or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. +or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. List of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. ### fn withPrivateKeyPath @@ -461,8 +502,20 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Prevent synchronizing users’ organization roles from your IdP. +(Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. +### fn withTokenUrl + +```jsonnet +withTokenUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers. +The token endpoint of your OAuth2 provider. Required for Azure AD providers. ### obj certificateSecretRef diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/index.md new file mode 100644 index 0000000..5d71649 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/index.md @@ -0,0 +1,39 @@ +# config + + + +## Subpackages + +* [servers](servers/index.md) + +## Index + +* [`fn withServers(value)`](#fn-withservers) +* [`fn withServersMixin(value)`](#fn-withserversmixin) + +## Fields + +### fn withServers + +```jsonnet +withServers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) +The LDAP servers configuration. +### fn withServersMixin + +```jsonnet +withServersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) +The LDAP servers configuration. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/groupMappings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/groupMappings.md new file mode 100644 index 0000000..6bfd273 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/groupMappings.md @@ -0,0 +1,62 @@ +# groupMappings + + + +## Index + +* [`fn withGrafanaAdmin(value=true)`](#fn-withgrafanaadmin) +* [`fn withGroupDn(value)`](#fn-withgroupdn) +* [`fn withOrgId(value)`](#fn-withorgid) +* [`fn withOrgRole(value)`](#fn-withorgrole) + +## Fields + +### fn withGrafanaAdmin + +```jsonnet +withGrafanaAdmin(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, it makes the user of group_dn Grafana server admin. +If set to true, it makes the user of group_dn Grafana server admin. +### fn withGroupDn + +```jsonnet +withGroupDn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). +LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). +### fn withOrgId + +```jsonnet +withOrgId(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The Grafana organization database id. +The Grafana organization database id. +### fn withOrgRole + +```jsonnet +withOrgRole(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Assign users of group_dn the organization role Admin, Editor, or Viewer. +Assign users of group_dn the organization role Admin, Editor, or Viewer. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/index.md new file mode 100644 index 0000000..63ce99d --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/config/servers/index.md @@ -0,0 +1,552 @@ +# servers + + + +## Subpackages + +* [groupMappings](groupMappings.md) + +## Index + +* [`fn withAttributes(value)`](#fn-withattributes) +* [`fn withAttributesMixin(value)`](#fn-withattributesmixin) +* [`fn withBindDn(value)`](#fn-withbinddn) +* [`fn withBindPasswordSecretRef(value)`](#fn-withbindpasswordsecretref) +* [`fn withBindPasswordSecretRefMixin(value)`](#fn-withbindpasswordsecretrefmixin) +* [`fn withClientCert(value)`](#fn-withclientcert) +* [`fn withClientCertValue(value)`](#fn-withclientcertvalue) +* [`fn withClientKeySecretRef(value)`](#fn-withclientkeysecretref) +* [`fn withClientKeySecretRefMixin(value)`](#fn-withclientkeysecretrefmixin) +* [`fn withClientKeyValueSecretRef(value)`](#fn-withclientkeyvaluesecretref) +* [`fn withClientKeyValueSecretRefMixin(value)`](#fn-withclientkeyvaluesecretrefmixin) +* [`fn withGroupMappings(value)`](#fn-withgroupmappings) +* [`fn withGroupMappingsMixin(value)`](#fn-withgroupmappingsmixin) +* [`fn withGroupSearchBaseDns(value)`](#fn-withgroupsearchbasedns) +* [`fn withGroupSearchBaseDnsMixin(value)`](#fn-withgroupsearchbasednsmixin) +* [`fn withGroupSearchFilter(value)`](#fn-withgroupsearchfilter) +* [`fn withGroupSearchFilterUserAttribute(value)`](#fn-withgroupsearchfilteruserattribute) +* [`fn withHost(value)`](#fn-withhost) +* [`fn withMinTlsVersion(value)`](#fn-withmintlsversion) +* [`fn withPort(value)`](#fn-withport) +* [`fn withRootCaCert(value)`](#fn-withrootcacert) +* [`fn withRootCaCertValue(value)`](#fn-withrootcacertvalue) +* [`fn withRootCaCertValueMixin(value)`](#fn-withrootcacertvaluemixin) +* [`fn withSearchBaseDns(value)`](#fn-withsearchbasedns) +* [`fn withSearchBaseDnsMixin(value)`](#fn-withsearchbasednsmixin) +* [`fn withSearchFilter(value)`](#fn-withsearchfilter) +* [`fn withSslSkipVerify(value=true)`](#fn-withsslskipverify) +* [`fn withStartTls(value=true)`](#fn-withstarttls) +* [`fn withTimeout(value)`](#fn-withtimeout) +* [`fn withTlsCiphers(value)`](#fn-withtlsciphers) +* [`fn withTlsCiphersMixin(value)`](#fn-withtlsciphersmixin) +* [`fn withUseSsl(value=true)`](#fn-withusessl) +* [`obj bindPasswordSecretRef`](#obj-bindpasswordsecretref) + * [`fn withKey(value)`](#fn-bindpasswordsecretrefwithkey) + * [`fn withName(value)`](#fn-bindpasswordsecretrefwithname) + * [`fn withNamespace(value)`](#fn-bindpasswordsecretrefwithnamespace) +* [`obj clientKeySecretRef`](#obj-clientkeysecretref) + * [`fn withKey(value)`](#fn-clientkeysecretrefwithkey) + * [`fn withName(value)`](#fn-clientkeysecretrefwithname) + * [`fn withNamespace(value)`](#fn-clientkeysecretrefwithnamespace) +* [`obj clientKeyValueSecretRef`](#obj-clientkeyvaluesecretref) + * [`fn withKey(value)`](#fn-clientkeyvaluesecretrefwithkey) + * [`fn withName(value)`](#fn-clientkeyvaluesecretrefwithname) + * [`fn withNamespace(value)`](#fn-clientkeyvaluesecretrefwithnamespace) + +## Fields + +### fn withAttributes + +```jsonnet +withAttributes(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +### fn withAttributesMixin + +```jsonnet +withAttributesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. +### fn withBindDn + +```jsonnet +withBindDn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The search user bind DN. +The search user bind DN. +### fn withBindPasswordSecretRef + +```jsonnet +withBindPasswordSecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The search user bind password. +The search user bind password. +### fn withBindPasswordSecretRefMixin + +```jsonnet +withBindPasswordSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The search user bind password. +The search user bind password. +### fn withClientCert + +```jsonnet +withClientCert(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The path to the client certificate. +The path to the client certificate. +### fn withClientCertValue + +```jsonnet +withClientCertValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The Base64 encoded value of the client certificate. +The Base64 encoded value of the client certificate. +### fn withClientKeySecretRef + +```jsonnet +withClientKeySecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The path to the client private key. +The path to the client private key. +### fn withClientKeySecretRefMixin + +```jsonnet +withClientKeySecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The path to the client private key. +The path to the client private key. +### fn withClientKeyValueSecretRef + +```jsonnet +withClientKeyValueSecretRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The Base64 encoded value of the client private key. +The Base64 encoded value of the client private key. +### fn withClientKeyValueSecretRefMixin + +```jsonnet +withClientKeyValueSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +(String, Sensitive) The Base64 encoded value of the client private key. +The Base64 encoded value of the client private key. +### fn withGroupMappings + +```jsonnet +withGroupMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) +For mapping an LDAP group to a Grafana organization and role. +### fn withGroupMappingsMixin + +```jsonnet +withGroupMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) +For mapping an LDAP group to a Grafana organization and role. +### fn withGroupSearchBaseDns + +```jsonnet +withGroupSearchBaseDns(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. +An array of the base DNs to search through for groups. Typically uses ou=groups. +### fn withGroupSearchBaseDnsMixin + +```jsonnet +withGroupSearchBaseDnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. +An array of the base DNs to search through for groups. Typically uses ou=groups. +### fn withGroupSearchFilter + +```jsonnet +withGroupSearchFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). +Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). +### fn withGroupSearchFilterUserAttribute + +```jsonnet +withGroupSearchFilterUserAttribute(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The %s in the search filter will be replaced with the attribute defined in this field. +The %s in the search filter will be replaced with the attribute defined in this field. +### fn withHost + +```jsonnet +withHost(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The LDAP server host. +The LDAP server host. +### fn withMinTlsVersion + +```jsonnet +withMinTlsVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. +Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. +### fn withPort + +```jsonnet +withPort(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The LDAP server port. +The LDAP server port. +### fn withRootCaCert + +```jsonnet +withRootCaCert(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The path to the root CA certificate. +The path to the root CA certificate. +### fn withRootCaCertValue + +```jsonnet +withRootCaCertValue(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) The Base64 encoded values of the root CA certificates. +The Base64 encoded values of the root CA certificates. +### fn withRootCaCertValueMixin + +```jsonnet +withRootCaCertValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) The Base64 encoded values of the root CA certificates. +The Base64 encoded values of the root CA certificates. +### fn withSearchBaseDns + +```jsonnet +withSearchBaseDns(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of base DNs to search through. +An array of base DNs to search through. +### fn withSearchBaseDnsMixin + +```jsonnet +withSearchBaseDnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) An array of base DNs to search through. +An array of base DNs to search through. +### fn withSearchFilter + +```jsonnet +withSearchFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". +The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". +### fn withSslSkipVerify + +```jsonnet +withSslSkipVerify(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, the SSL cert validation will be skipped. +If set to true, the SSL cert validation will be skipped. +### fn withStartTls + +```jsonnet +withStartTls(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS. +If set to true, use LDAP with STARTTLS instead of LDAPS. +### fn withTimeout + +```jsonnet +withTimeout(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The timeout in seconds for connecting to the LDAP host. +The timeout in seconds for connecting to the LDAP host. +### fn withTlsCiphers + +```jsonnet +withTlsCiphers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +### fn withTlsCiphersMixin + +```jsonnet +withTlsCiphersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. +### fn withUseSsl + +```jsonnet +withUseSsl(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). +Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). +### obj bindPasswordSecretRef + + +#### fn bindPasswordSecretRef.withKey + +```jsonnet +bindPasswordSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn bindPasswordSecretRef.withName + +```jsonnet +bindPasswordSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn bindPasswordSecretRef.withNamespace + +```jsonnet +bindPasswordSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. +### obj clientKeySecretRef + + +#### fn clientKeySecretRef.withKey + +```jsonnet +clientKeySecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn clientKeySecretRef.withName + +```jsonnet +clientKeySecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn clientKeySecretRef.withNamespace + +```jsonnet +clientKeySecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. +### obj clientKeyValueSecretRef + + +#### fn clientKeyValueSecretRef.withKey + +```jsonnet +clientKeyValueSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn clientKeyValueSecretRef.withName + +```jsonnet +clientKeyValueSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn clientKeyValueSecretRef.withNamespace + +```jsonnet +clientKeyValueSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/index.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/index.md new file mode 100644 index 0000000..4ddab01 --- /dev/null +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/ldapSettings/index.md @@ -0,0 +1,81 @@ +# ldapSettings + + + +## Subpackages + +* [config](config/index.md) + +## Index + +* [`fn withAllowSignUp(value=true)`](#fn-withallowsignup) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withSkipOrgRoleSync(value=true)`](#fn-withskiporgrolesync) + +## Fields + +### fn withAllowSignUp + +```jsonnet +withAllowSignUp(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. +Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) +The LDAP configuration. +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) +The LDAP configuration. +### fn withEnabled + +```jsonnet +withEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. +Define whether this configuration is enabled for LDAP. Defaults to `true`. +### fn withSkipOrgRoleSync + +```jsonnet +withSkipOrgRoleSync(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Prevent synchronizing users’ organization roles from LDAP. +Prevent synchronizing users’ organization roles from LDAP. \ No newline at end of file diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/oauth2Settings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/oauth2Settings.md index 5a6c54c..9953fc9 100644 --- a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/oauth2Settings.md +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/oauth2Settings.md @@ -29,6 +29,8 @@ * [`fn withLoginAttributePath(value)`](#fn-withloginattributepath) * [`fn withName(value)`](#fn-withname) * [`fn withNameAttributePath(value)`](#fn-withnameattributepath) +* [`fn withOrgAttributePath(value)`](#fn-withorgattributepath) +* [`fn withOrgMapping(value)`](#fn-withorgmapping) * [`fn withRoleAttributePath(value)`](#fn-withroleattributepath) * [`fn withRoleAttributeStrict(value=true)`](#fn-withroleattributestrict) * [`fn withScopes(value)`](#fn-withscopes) @@ -75,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) If not enabled, only existing Grafana users can log in using OAuth. +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. If not enabled, only existing Grafana users can log in using OAuth. ### fn withAllowedDomains @@ -296,7 +298,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for the specified provider. Defaults to `true`. ### fn withGroupsAttributePath @@ -358,6 +360,30 @@ PARAMETERS: (String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. +### fn withOrgAttributePath + +```jsonnet +withOrgAttributePath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. +JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. +### fn withOrgMapping + +```jsonnet +withOrgMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + +or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. +List of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. ### fn withRoleAttributePath ```jsonnet @@ -418,7 +444,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Prevent synchronizing users’ organization roles from your IdP. +(Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. ### fn withTeamIds diff --git a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/samlSettings.md b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/samlSettings.md index c3797e2..4fd0ef5 100644 --- a/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/samlSettings.md +++ b/docs/raw/oss/v1alpha1/ssoSettings/spec/parameters/initProvider/samlSettings.md @@ -17,7 +17,10 @@ * [`fn withCertificatePath(value)`](#fn-withcertificatepath) * [`fn withCertificateSecretRef(value)`](#fn-withcertificatesecretref) * [`fn withCertificateSecretRefMixin(value)`](#fn-withcertificatesecretrefmixin) +* [`fn withClientId(value)`](#fn-withclientid) +* [`fn withClientSecret(value)`](#fn-withclientsecret) * [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withForceUseGraphApi(value=true)`](#fn-withforceusegraphapi) * [`fn withIdpMetadata(value)`](#fn-withidpmetadata) * [`fn withIdpMetadataPath(value)`](#fn-withidpmetadatapath) * [`fn withIdpMetadataUrl(value)`](#fn-withidpmetadataurl) @@ -38,6 +41,7 @@ * [`fn withSignatureAlgorithm(value)`](#fn-withsignaturealgorithm) * [`fn withSingleLogout(value=true)`](#fn-withsinglelogout) * [`fn withSkipOrgRoleSync(value=true)`](#fn-withskiporgrolesync) +* [`fn withTokenUrl(value)`](#fn-withtokenurl) * [`obj certificateSecretRef`](#obj-certificatesecretref) * [`fn withKey(value)`](#fn-certificatesecretrefwithkey) * [`fn withName(value)`](#fn-certificatesecretrefwithname) @@ -73,7 +77,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) If not enabled, only existing Grafana users can log in using OAuth. +(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. Whether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML. ### fn withAllowedOrganizations @@ -208,6 +212,30 @@ PARAMETERS: encoded string for the SP X.509 certificate. Base64-encoded string for the SP X.509 certificate. +### fn withClientId + +```jsonnet +withClientId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The client Id of your OAuth2 app. +The client Id of your OAuth2 app. +### fn withClientSecret + +```jsonnet +withClientSecret(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String, Sensitive) The client secret of your OAuth2 app. +The client secret of your OAuth2 app. ### fn withEnabled ```jsonnet @@ -219,8 +247,21 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. +(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for SAML. Defaults to `true`. +### fn withForceUseGraphApi + +```jsonnet +withForceUseGraphApi(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. +If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. ### fn withIdpMetadata ```jsonnet @@ -315,7 +356,7 @@ PARAMETERS: * **value** (`string`) -or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. +or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. List of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. ### fn withPrivateKeyPath @@ -461,8 +502,20 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -(Boolean) Prevent synchronizing users’ organization roles from your IdP. +(Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. +### fn withTokenUrl + +```jsonnet +withTokenUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers. +The token endpoint of your OAuth2 provider. Required for Azure AD providers. ### obj certificateSecretRef diff --git a/docs/raw/slo/v1alpha1/slo/index.md b/docs/raw/slo/v1alpha1/slo/index.md index e7bc34b..81a4cac 100644 --- a/docs/raw/slo/v1alpha1/slo/index.md +++ b/docs/raw/slo/v1alpha1/slo/index.md @@ -94,6 +94,7 @@ * [`fn withObjectivesMixin(value)`](#fn-specparametersforproviderwithobjectivesmixin) * [`fn withQuery(value)`](#fn-specparametersforproviderwithquery) * [`fn withQueryMixin(value)`](#fn-specparametersforproviderwithquerymixin) + * [`fn withSearchExpression(value)`](#fn-specparametersforproviderwithsearchexpression) * [`obj initProvider`](#obj-specparametersinitprovider) * [`fn withAlerting(value)`](#fn-specparametersinitproviderwithalerting) * [`fn withAlertingMixin(value)`](#fn-specparametersinitproviderwithalertingmixin) @@ -108,6 +109,7 @@ * [`fn withObjectivesMixin(value)`](#fn-specparametersinitproviderwithobjectivesmixin) * [`fn withQuery(value)`](#fn-specparametersinitproviderwithquery) * [`fn withQueryMixin(value)`](#fn-specparametersinitproviderwithquerymixin) + * [`fn withSearchExpression(value)`](#fn-specparametersinitproviderwithsearchexpression) * [`obj providerConfigRef`](#obj-specparametersproviderconfigref) * [`fn withName(value)`](#fn-specparametersproviderconfigrefwithname) * [`fn withPolicy(value)`](#fn-specparametersproviderconfigrefwithpolicy) @@ -1048,6 +1050,18 @@ PARAMETERS: (Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. +###### fn spec.parameters.forProvider.withSearchExpression + +```jsonnet +spec.parameters.forProvider.withSearchExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. +The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. ##### obj spec.parameters.initProvider @@ -1219,6 +1233,18 @@ PARAMETERS: (Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. +###### fn spec.parameters.initProvider.withSearchExpression + +```jsonnet +spec.parameters.initProvider.withSearchExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. +The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. ##### obj spec.parameters.providerConfigRef diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/fastburn/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/alerting/slowburn/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/forProvider/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/fastburn/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/annotation.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/annotation.md index bfe706c..2cc0b16 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/annotation.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/annotation.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/alerting/slowburn/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/label.md b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/label.md index b2fed8b..4846f75 100644 --- a/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/label.md +++ b/docs/raw/slo/v1alpha1/slo/spec/parameters/initProvider/label.md @@ -19,7 +19,8 @@ PARAMETERS: * **value** (`string`) -(String) +(String) Key for filtering and identification +Key for filtering and identification ### fn withValue ```jsonnet @@ -30,4 +31,5 @@ PARAMETERS: * **value** (`string`) -(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. \ No newline at end of file +(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. +Templatable value \ No newline at end of file diff --git a/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/basicAuth.md b/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/basicAuth.md index 3ad1e11..91fb638 100644 --- a/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/basicAuth.md +++ b/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/basicAuth.md @@ -4,22 +4,39 @@ ## Index -* [`fn withPassword(value)`](#fn-withpassword) +* [`fn withPasswordSecretRef(value)`](#fn-withpasswordsecretref) +* [`fn withPasswordSecretRefMixin(value)`](#fn-withpasswordsecretrefmixin) * [`fn withUsername(value)`](#fn-withusername) +* [`obj passwordSecretRef`](#obj-passwordsecretref) + * [`fn withKey(value)`](#fn-passwordsecretrefwithkey) + * [`fn withName(value)`](#fn-passwordsecretrefwithname) + * [`fn withNamespace(value)`](#fn-passwordsecretrefwithnamespace) ## Fields -### fn withPassword +### fn withPasswordSecretRef ```jsonnet -withPassword(value) +withPasswordSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Basic auth password. +Basic auth password. +### fn withPasswordSecretRefMixin + +```jsonnet +withPasswordSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Basic auth password. +(String, Sensitive) Basic auth password. Basic auth password. ### fn withUsername @@ -32,4 +49,40 @@ PARAMETERS: * **value** (`string`) (String) Basic auth username. -Basic auth username. \ No newline at end of file +Basic auth username. +### obj passwordSecretRef + + +#### fn passwordSecretRef.withKey + +```jsonnet +passwordSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn passwordSecretRef.withName + +```jsonnet +passwordSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn passwordSecretRef.withNamespace + +```jsonnet +passwordSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/index.md b/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/index.md index 8256c3d..f1a79f1 100644 --- a/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/index.md +++ b/docs/raw/sm/v1alpha1/check/spec/parameters/forProvider/settings/http/index.md @@ -13,7 +13,8 @@ * [`fn withBasicAuth(value)`](#fn-withbasicauth) * [`fn withBasicAuthMixin(value)`](#fn-withbasicauthmixin) -* [`fn withBearerToken(value)`](#fn-withbearertoken) +* [`fn withBearerTokenSecretRef(value)`](#fn-withbearertokensecretref) +* [`fn withBearerTokenSecretRefMixin(value)`](#fn-withbearertokensecretrefmixin) * [`fn withBody(value)`](#fn-withbody) * [`fn withCacheBustingQueryParamName(value)`](#fn-withcachebustingqueryparamname) * [`fn withFailIfBodyMatchesRegexp(value)`](#fn-withfailifbodymatchesregexp) @@ -40,6 +41,10 @@ * [`fn withValidHttpVersionsMixin(value)`](#fn-withvalidhttpversionsmixin) * [`fn withValidStatusCodes(value)`](#fn-withvalidstatuscodes) * [`fn withValidStatusCodesMixin(value)`](#fn-withvalidstatuscodesmixin) +* [`obj bearerTokenSecretRef`](#obj-bearertokensecretref) + * [`fn withKey(value)`](#fn-bearertokensecretrefwithkey) + * [`fn withName(value)`](#fn-bearertokensecretrefwithname) + * [`fn withNamespace(value)`](#fn-bearertokensecretrefwithnamespace) ## Fields @@ -67,17 +72,29 @@ PARAMETERS: (Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings. -### fn withBearerToken +### fn withBearerTokenSecretRef ```jsonnet -withBearerToken(value) +withBearerTokenSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Token for use with bearer authorization header. +Token for use with bearer authorization header. +### fn withBearerTokenSecretRefMixin + +```jsonnet +withBearerTokenSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Token for use with bearer authorization header. +(String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header. ### fn withBody @@ -393,4 +410,40 @@ PARAMETERS: * **value** (`array`) (Set of Number) Accepted status codes. If unset, defaults to 2xx. -Accepted status codes. If unset, defaults to 2xx. \ No newline at end of file +Accepted status codes. If unset, defaults to 2xx. +### obj bearerTokenSecretRef + + +#### fn bearerTokenSecretRef.withKey + +```jsonnet +bearerTokenSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn bearerTokenSecretRef.withName + +```jsonnet +bearerTokenSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn bearerTokenSecretRef.withNamespace + +```jsonnet +bearerTokenSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/basicAuth.md b/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/basicAuth.md index 3ad1e11..91fb638 100644 --- a/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/basicAuth.md +++ b/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/basicAuth.md @@ -4,22 +4,39 @@ ## Index -* [`fn withPassword(value)`](#fn-withpassword) +* [`fn withPasswordSecretRef(value)`](#fn-withpasswordsecretref) +* [`fn withPasswordSecretRefMixin(value)`](#fn-withpasswordsecretrefmixin) * [`fn withUsername(value)`](#fn-withusername) +* [`obj passwordSecretRef`](#obj-passwordsecretref) + * [`fn withKey(value)`](#fn-passwordsecretrefwithkey) + * [`fn withName(value)`](#fn-passwordsecretrefwithname) + * [`fn withNamespace(value)`](#fn-passwordsecretrefwithnamespace) ## Fields -### fn withPassword +### fn withPasswordSecretRef ```jsonnet -withPassword(value) +withPasswordSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Basic auth password. +Basic auth password. +### fn withPasswordSecretRefMixin + +```jsonnet +withPasswordSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Basic auth password. +(String, Sensitive) Basic auth password. Basic auth password. ### fn withUsername @@ -32,4 +49,40 @@ PARAMETERS: * **value** (`string`) (String) Basic auth username. -Basic auth username. \ No newline at end of file +Basic auth username. +### obj passwordSecretRef + + +#### fn passwordSecretRef.withKey + +```jsonnet +passwordSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn passwordSecretRef.withName + +```jsonnet +passwordSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn passwordSecretRef.withNamespace + +```jsonnet +passwordSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/index.md b/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/index.md index 8256c3d..f1a79f1 100644 --- a/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/index.md +++ b/docs/raw/sm/v1alpha1/check/spec/parameters/initProvider/settings/http/index.md @@ -13,7 +13,8 @@ * [`fn withBasicAuth(value)`](#fn-withbasicauth) * [`fn withBasicAuthMixin(value)`](#fn-withbasicauthmixin) -* [`fn withBearerToken(value)`](#fn-withbearertoken) +* [`fn withBearerTokenSecretRef(value)`](#fn-withbearertokensecretref) +* [`fn withBearerTokenSecretRefMixin(value)`](#fn-withbearertokensecretrefmixin) * [`fn withBody(value)`](#fn-withbody) * [`fn withCacheBustingQueryParamName(value)`](#fn-withcachebustingqueryparamname) * [`fn withFailIfBodyMatchesRegexp(value)`](#fn-withfailifbodymatchesregexp) @@ -40,6 +41,10 @@ * [`fn withValidHttpVersionsMixin(value)`](#fn-withvalidhttpversionsmixin) * [`fn withValidStatusCodes(value)`](#fn-withvalidstatuscodes) * [`fn withValidStatusCodesMixin(value)`](#fn-withvalidstatuscodesmixin) +* [`obj bearerTokenSecretRef`](#obj-bearertokensecretref) + * [`fn withKey(value)`](#fn-bearertokensecretrefwithkey) + * [`fn withName(value)`](#fn-bearertokensecretrefwithname) + * [`fn withNamespace(value)`](#fn-bearertokensecretrefwithnamespace) ## Fields @@ -67,17 +72,29 @@ PARAMETERS: (Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings. -### fn withBearerToken +### fn withBearerTokenSecretRef ```jsonnet -withBearerToken(value) +withBearerTokenSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Token for use with bearer authorization header. +Token for use with bearer authorization header. +### fn withBearerTokenSecretRefMixin + +```jsonnet +withBearerTokenSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Token for use with bearer authorization header. +(String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header. ### fn withBody @@ -393,4 +410,40 @@ PARAMETERS: * **value** (`array`) (Set of Number) Accepted status codes. If unset, defaults to 2xx. -Accepted status codes. If unset, defaults to 2xx. \ No newline at end of file +Accepted status codes. If unset, defaults to 2xx. +### obj bearerTokenSecretRef + + +#### fn bearerTokenSecretRef.withKey + +```jsonnet +bearerTokenSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn bearerTokenSecretRef.withName + +```jsonnet +bearerTokenSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn bearerTokenSecretRef.withNamespace + +```jsonnet +bearerTokenSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/sm/check/settings/http/basicAuth.md b/docs/sm/check/settings/http/basicAuth.md index 3ad1e11..91fb638 100644 --- a/docs/sm/check/settings/http/basicAuth.md +++ b/docs/sm/check/settings/http/basicAuth.md @@ -4,22 +4,39 @@ ## Index -* [`fn withPassword(value)`](#fn-withpassword) +* [`fn withPasswordSecretRef(value)`](#fn-withpasswordsecretref) +* [`fn withPasswordSecretRefMixin(value)`](#fn-withpasswordsecretrefmixin) * [`fn withUsername(value)`](#fn-withusername) +* [`obj passwordSecretRef`](#obj-passwordsecretref) + * [`fn withKey(value)`](#fn-passwordsecretrefwithkey) + * [`fn withName(value)`](#fn-passwordsecretrefwithname) + * [`fn withNamespace(value)`](#fn-passwordsecretrefwithnamespace) ## Fields -### fn withPassword +### fn withPasswordSecretRef ```jsonnet -withPassword(value) +withPasswordSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Basic auth password. +Basic auth password. +### fn withPasswordSecretRefMixin + +```jsonnet +withPasswordSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Basic auth password. +(String, Sensitive) Basic auth password. Basic auth password. ### fn withUsername @@ -32,4 +49,40 @@ PARAMETERS: * **value** (`string`) (String) Basic auth username. -Basic auth username. \ No newline at end of file +Basic auth username. +### obj passwordSecretRef + + +#### fn passwordSecretRef.withKey + +```jsonnet +passwordSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn passwordSecretRef.withName + +```jsonnet +passwordSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn passwordSecretRef.withNamespace + +```jsonnet +passwordSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/docs/sm/check/settings/http/index.md b/docs/sm/check/settings/http/index.md index 11920d9..1631665 100644 --- a/docs/sm/check/settings/http/index.md +++ b/docs/sm/check/settings/http/index.md @@ -14,7 +14,8 @@ * [`fn new(validStatusCodes=[200])`](#fn-new) * [`fn withBasicAuth(value)`](#fn-withbasicauth) * [`fn withBasicAuthMixin(value)`](#fn-withbasicauthmixin) -* [`fn withBearerToken(value)`](#fn-withbearertoken) +* [`fn withBearerTokenSecretRef(value)`](#fn-withbearertokensecretref) +* [`fn withBearerTokenSecretRefMixin(value)`](#fn-withbearertokensecretrefmixin) * [`fn withBody(value)`](#fn-withbody) * [`fn withCacheBustingQueryParamName(value)`](#fn-withcachebustingqueryparamname) * [`fn withFailIfBodyMatchesRegexp(value)`](#fn-withfailifbodymatchesregexp) @@ -41,6 +42,10 @@ * [`fn withValidHttpVersionsMixin(value)`](#fn-withvalidhttpversionsmixin) * [`fn withValidStatusCodes(value)`](#fn-withvalidstatuscodes) * [`fn withValidStatusCodesMixin(value)`](#fn-withvalidstatuscodesmixin) +* [`obj bearerTokenSecretRef`](#obj-bearertokensecretref) + * [`fn withKey(value)`](#fn-bearertokensecretrefwithkey) + * [`fn withName(value)`](#fn-bearertokensecretrefwithname) + * [`fn withNamespace(value)`](#fn-bearertokensecretrefwithnamespace) ## Fields @@ -81,17 +86,29 @@ PARAMETERS: (Block Set, Max: 1) Basic auth settings. (see below for nested schema) Basic auth settings. -### fn withBearerToken +### fn withBearerTokenSecretRef ```jsonnet -withBearerToken(value) +withBearerTokenSecretRef(value) ``` PARAMETERS: -* **value** (`string`) +* **value** (`object`) + +(String, Sensitive) Token for use with bearer authorization header. +Token for use with bearer authorization header. +### fn withBearerTokenSecretRefMixin + +```jsonnet +withBearerTokenSecretRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) -(String) Token for use with bearer authorization header. +(String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header. ### fn withBody @@ -407,4 +424,40 @@ PARAMETERS: * **value** (`array`) (Set of Number) Accepted status codes. If unset, defaults to 2xx. -Accepted status codes. If unset, defaults to 2xx. \ No newline at end of file +Accepted status codes. If unset, defaults to 2xx. +### obj bearerTokenSecretRef + + +#### fn bearerTokenSecretRef.withKey + +```jsonnet +bearerTokenSecretRef.withKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The key to select. +#### fn bearerTokenSecretRef.withName + +```jsonnet +bearerTokenSecretRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the secret. +#### fn bearerTokenSecretRef.withNamespace + +```jsonnet +bearerTokenSecretRef.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Namespace of the secret. \ No newline at end of file diff --git a/generator/crds.yaml b/generator/crds.yaml index 21e0f02..98f2836 100644 --- a/generator/crds.yaml +++ b/generator/crds.yaml @@ -35,8 +35,7 @@ spec: schema: openAPIV3Schema: description: ContactPoint is the Schema for the ContactPoints API. Manages - Grafana Alerting contact points. Official documentation https://grafana.com/docs/grafana/next/alerting/fundamentals/notifications/contact-points/HTTP - API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points + Grafana Alerting contact points. Official documentation https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points This resource requires Grafana 9.1.0 or later. properties: apiVersion: @@ -4652,8 +4651,7 @@ spec: schema: openAPIV3Schema: description: MessageTemplate is the Schema for the MessageTemplates API. Manages - Grafana Alerting message templates. Official documentation https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/create-notification-templates/HTTP - API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#templates + Grafana Alerting message templates. Official documentation https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#templates This resource requires Grafana 9.1.0 or later. properties: apiVersion: @@ -5192,8 +5190,7 @@ spec: schema: openAPIV3Schema: description: MuteTiming is the Schema for the MuteTimings API. Manages Grafana - Alerting mute timings. Official documentation https://grafana.com/docs/grafana/latest/alerting/configure-notifications/mute-timings/HTTP - API https://grafana.com/docs/grafana/next/developers/http_api/alerting_provisioning/#mute-timings + Alerting mute timings. Official documentation https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#mute-timings This resource requires Grafana 9.1.0 or later. properties: apiVersion: @@ -5892,8 +5889,7 @@ spec: description: NotificationPolicy is the Schema for the NotificationPolicys API. Sets the global notification policy for Grafana. !> This resource manages the entire notification policy tree, and will overwrite any existing policies. - Official documentation https://grafana.com/docs/grafana/latest/alerting/configure-notifications/HTTP - API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/ + Official documentation https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#notification-policies This resource requires Grafana 9.1.0 or later. properties: apiVersion: @@ -8717,8 +8713,7 @@ spec: schema: openAPIV3Schema: description: RuleGroup is the Schema for the RuleGroups API. Manages Grafana - Alerting rule groups. Official documentation https://grafana.com/docs/grafana/latest/alerting/alerting-rules/HTTP - API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules + Alerting rule groups. Official documentation https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules This resource requires Grafana 9.1.0 or later. properties: apiVersion: @@ -8938,8 +8933,8 @@ spec: additionalProperties: type: string description: |- - value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. - Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. + value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. + Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. type: object x-kubernetes-map-type: granular condition: @@ -9341,8 +9336,8 @@ spec: additionalProperties: type: string description: |- - value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. - Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. + value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. + Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. type: object x-kubernetes-map-type: granular condition: @@ -9771,8 +9766,8 @@ spec: additionalProperties: type: string description: |- - value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[]. - Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`. + value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[]. + Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`. type: object x-kubernetes-map-type: granular condition: @@ -18313,7 +18308,9 @@ spec: name: v1alpha1 schema: openAPIV3Schema: - description: Holiday is the Schema for the Holidays API. + description: 'Holiday is the Schema for the Holidays API. A holiday describes + time periods where a time series is expected to behave differently to normal. + To use a holiday in a job, use its id in the holidays attribute of a grafana_machine_learning_job:' properties: apiVersion: description: |- @@ -18724,7 +18721,8 @@ spec: name: v1alpha1 schema: openAPIV3Schema: - description: Job is the Schema for the Jobs API. + description: Job is the Schema for the Jobs API. A job defines the queries + and model parameters for a machine learning task. properties: apiVersion: description: |- @@ -19373,8 +19371,11 @@ spec: name: v1alpha1 schema: openAPIV3Schema: - description: OutlierDetector is the Schema for the OutlierDetectors API. + description: OutlierDetector is the Schema for the OutlierDetectors API. An + outlier detector monitors the results of a query and reports when its values + are outside normal bands. The normal band is configured by choice of algorithm, + its sensitivity and other configuration. Visit https://grafana.com/docs/grafana-cloud/machine-learning/outlier-detection/ + for more details. properties: apiVersion: description: |- @@ -20512,8 +20513,8 @@ spec: type: object duration: description: |- - (Number) The duration of delay for wait type step. - The duration of delay for wait type step. + 86400) seconds + The duration of delay for wait type step. (60-86400) seconds type: number escalationChainId: description: |- @@ -20721,10 +20722,15 @@ spec: (Number) The position of the escalation step (starts from 0). The position of the escalation step (starts from 0). type: number + severity: + description: |- + (String) The severity of the incident for declare_incident type step. + The severity of the incident for declare_incident type step. + type: string type: description: |- - (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members - The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members + (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident + The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident type: string type: object initProvider: @@ -20823,8 +20829,8 @@ spec: type: object duration: description: |- - (Number) The duration of delay for wait type step. - The duration of delay for wait type step. + 86400) seconds + The duration of delay for wait type step. (60-86400) seconds type: number escalationChainId: description: |- @@ -21032,10 +21038,15 @@ spec: (Number) The position of the escalation step (starts from 0). The position of the escalation step (starts from 0). type: number + severity: + description: |- + (String) The severity of the incident for declare_incident type step. + The severity of the incident for declare_incident type step. + type: string type: description: |- - (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members - The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members + (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident + The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident type: string type: object managementPolicies: @@ -21226,8 +21237,8 @@ spec: type: string duration: description: |- - (Number) The duration of delay for wait type step. - The duration of delay for wait type step. + 86400) seconds + The duration of delay for wait type step. (60-86400) seconds type: number escalationChainId: description: |- @@ -21288,10 +21299,15 @@ spec: (Number) The position of the escalation step (starts from 0). The position of the escalation step (starts from 0). type: number + severity: + description: |- + (String) The severity of the incident for declare_incident type step. + The severity of the incident for declare_incident type step. + type: string type: description: |- - (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members - The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members + (String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident + The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident type: string type: object conditions: @@ -21392,8 +21408,8 @@ spec: schema: openAPIV3Schema: description: Integration is the Schema for the Integrations API. Official - documentation https://grafana.com/docs/oncall/latest/integrations/HTTP API - https://grafana.com/docs/oncall/latest/oncall-api-reference/ + documentation https://grafana.com/docs/oncall/latest/configure/integrations/HTTP + API https://grafana.com/docs/oncall/latest/oncall-api-reference/ properties: apiVersion: description: |- @@ -21620,8 +21636,8 @@ spec: type: string microsoftTeams: description: |- - (Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) - Templates for Microsoft Teams. + (Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) + Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. items: properties: imageUrl: @@ -21641,6 +21657,24 @@ spec: type: string type: object type: array + mobileApp: + description: |- + (Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) + Templates for Mobile app push notifications. + items: + properties: + message: + description: |- + (String) Template for Alert message. + Template for Alert message. + type: string + title: + description: |- + (String) Template for Alert title. + Template for Alert title. + type: string + type: object + type: array phoneCall: description: |- (Block List, Max: 1) Templates for Phone Call. (see below for nested schema) @@ -21956,8 +21990,8 @@ spec: type: string microsoftTeams: description: |- - (Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) - Templates for Microsoft Teams. + (Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) + Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. items: properties: imageUrl: @@ -21977,6 +22011,24 @@ spec: type: string type: object type: array + mobileApp: + description: |- + (Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) + Templates for Mobile app push notifications. + items: + properties: + message: + description: |- + (String) Template for Alert message. + Template for Alert message. + type: string + title: + description: |- + (String) Template for Alert title. + Template for Alert title. + type: string + type: object + type: array phoneCall: description: |- (Block List, Max: 1) Templates for Phone Call. (see below for nested schema) @@ -22399,8 +22451,8 @@ spec: type: string microsoftTeams: description: |- - (Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema) - Templates for Microsoft Teams. + (Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema) + Templates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud. items: properties: imageUrl: @@ -22420,6 +22472,24 @@ spec: type: string type: object type: array + mobileApp: + description: |- + (Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema) + Templates for Mobile app push notifications. + items: + properties: + message: + description: |- + (String) Template for Alert message. + Template for Alert message. + type: string + title: + description: |- + (String) Template for Alert title. + Template for Alert title. + type: string + type: object + type: array phoneCall: description: |- (Block List, Max: 1) Templates for Phone Call. (see below for nested schema) @@ -22752,6 +22822,11 @@ spec: (String) The shift's type. Can be rolling_users, recurrent_event, single_event The shift's type. Can be rolling_users, recurrent_event, single_event type: string + until: + description: |- + call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + type: string users: description: |- call users (for single_event and recurrent_event event type). @@ -22862,6 +22937,11 @@ spec: (String) The shift's type. Can be rolling_users, recurrent_event, single_event The shift's type. Can be rolling_users, recurrent_event, single_event type: string + until: + description: |- + call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + type: string users: description: |- call users (for single_event and recurrent_event event type). @@ -23151,6 +23231,11 @@ spec: (String) The shift's type. Can be rolling_users, recurrent_event, single_event The shift's type. Can be rolling_users, recurrent_event, single_event type: string + until: + description: |- + call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") + type: string users: description: |- call users (for single_event and recurrent_event event type). @@ -32847,7 +32932,8 @@ spec: API https://grafana.com/docs/grafana/latest/developers/http_api/org/ This resource represents an instance-scoped resource and uses Grafana's admin APIs. It does not work with API tokens or service accounts which are org-scoped. - You must use basic auth. + You must use basic auth. This resource is also not compatible with Grafana + Cloud, as it does not allow basic auth. properties: apiVersion: description: |- @@ -36120,9 +36206,9 @@ spec: schema: openAPIV3Schema: description: SsoSettings is the Schema for the SsoSettingss API. Manages Grafana - SSO Settings for OAuth2 and SAML. Support for SAML is currently in preview, - it will be available in Grafana Enterprise starting with v11.1. Official - documentation https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/HTTP + SSO Settings for OAuth2, SAML and LDAP. Support for LDAP is currently in + preview, it will be available in Grafana starting with v11.3. Official documentation + https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/sso-settings/ properties: apiVersion: @@ -36161,6 +36247,236 @@ spec: type: string forProvider: properties: + ldapSettings: + description: |- + (Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) + The LDAP settings set. Required for the ldap provider. + items: + properties: + allowSignUp: + description: |- + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + type: boolean + config: + description: |- + (Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) + The LDAP configuration. + items: + properties: + servers: + description: |- + (Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) + The LDAP servers configuration. + items: + properties: + attributes: + additionalProperties: + type: string + description: |- + (Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + type: object + x-kubernetes-map-type: granular + bindDn: + description: |- + (String) The search user bind DN. + The search user bind DN. + type: string + bindPasswordSecretRef: + description: |- + (String, Sensitive) The search user bind password. + The search user bind password. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + clientCert: + description: |- + (String) The path to the client certificate. + The path to the client certificate. + type: string + clientCertValue: + description: |- + (String) The Base64 encoded value of the client certificate. + The Base64 encoded value of the client certificate. + type: string + clientKeySecretRef: + description: |- + (String, Sensitive) The path to the client private key. + The path to the client private key. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + clientKeyValueSecretRef: + description: |- + (String, Sensitive) The Base64 encoded value of the client private key. + The Base64 encoded value of the client private key. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + groupMappings: + description: |- + (Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) + For mapping an LDAP group to a Grafana organization and role. + items: + properties: + grafanaAdmin: + description: |- + (Boolean) If set to true, it makes the user of group_dn Grafana server admin. + If set to true, it makes the user of group_dn Grafana server admin. + type: boolean + groupDn: + description: |- + (String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + type: string + orgId: + description: |- + (Number) The Grafana organization database id. + The Grafana organization database id. + type: number + orgRole: + description: |- + (String) Assign users of group_dn the organization role Admin, Editor, or Viewer. + Assign users of group_dn the organization role Admin, Editor, or Viewer. + type: string + type: object + type: array + groupSearchBaseDns: + description: |- + (List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. + An array of the base DNs to search through for groups. Typically uses ou=groups. + items: + type: string + type: array + groupSearchFilter: + description: |- + (String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + type: string + groupSearchFilterUserAttribute: + description: |- + (String) The %s in the search filter will be replaced with the attribute defined in this field. + The %s in the search filter will be replaced with the attribute defined in this field. + type: string + host: + description: |- + (String) The LDAP server host. + The LDAP server host. + type: string + minTlsVersion: + description: |- + (String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + type: string + port: + description: |- + (Number) The LDAP server port. + The LDAP server port. + type: number + rootCaCert: + description: |- + (String) The path to the root CA certificate. + The path to the root CA certificate. + type: string + rootCaCertValue: + description: |- + (List of String) The Base64 encoded values of the root CA certificates. + The Base64 encoded values of the root CA certificates. + items: + type: string + type: array + searchBaseDns: + description: |- + (List of String) An array of base DNs to search through. + An array of base DNs to search through. + items: + type: string + type: array + searchFilter: + description: |- + (String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + type: string + sslSkipVerify: + description: |- + (Boolean) If set to true, the SSL cert validation will be skipped. + If set to true, the SSL cert validation will be skipped. + type: boolean + startTls: + description: |- + (Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS. + If set to true, use LDAP with STARTTLS instead of LDAPS. + type: boolean + timeout: + description: |- + (Number) The timeout in seconds for connecting to the LDAP host. + The timeout in seconds for connecting to the LDAP host. + type: number + tlsCiphers: + description: |- + (List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + items: + type: string + type: array + useSsl: + description: |- + (Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + type: boolean + type: object + type: array + type: object + type: array + enabled: + description: |- + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. + Define whether this configuration is enabled for LDAP. Defaults to `true`. + type: boolean + skipOrgRoleSync: + description: |- + (Boolean) Prevent synchronizing users’ organization roles from LDAP. + Prevent synchronizing users’ organization roles from LDAP. + type: boolean + type: object + type: array oauth2Settings: description: |- (Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema) @@ -36174,7 +36490,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. If not enabled, only existing Grafana users can log in using OAuth. type: boolean allowedDomains: @@ -36271,7 +36587,7 @@ spec: type: boolean enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for the specified provider. Defaults to `true`. type: boolean groupsAttributePath: @@ -36299,6 +36615,16 @@ spec: (String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. type: string + orgAttributePath: + description: |- + (String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + type: string + orgMapping: + description: |- + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + List of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + type: string roleAttributePath: description: |- (String) JMESPath expression to use for Grafana role lookup. @@ -36321,7 +36647,7 @@ spec: type: string skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean teamIds: @@ -36378,8 +36704,8 @@ spec: type: array providerName: description: |- - (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. - The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. + (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. + The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. type: string samlSettings: description: |- @@ -36394,7 +36720,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. Whether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML. type: boolean allowedOrganizations: @@ -36461,11 +36787,26 @@ spec: - name - namespace type: object + clientId: + description: |- + (String) The client Id of your OAuth2 app. + The client Id of your OAuth2 app. + type: string + clientSecret: + description: |- + (String, Sensitive) The client secret of your OAuth2 app. + The client secret of your OAuth2 app. + type: string enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for SAML. Defaults to `true`. type: boolean + forceUseGraphApi: + description: |- + (Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + type: boolean idpMetadata: description: |- encoded string for the IdP SAML metadata XML. @@ -36503,7 +36844,7 @@ spec: type: string orgMapping: description: |- - or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. List of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. type: string privateKeyPath: @@ -36572,9 +36913,14 @@ spec: type: boolean skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean + tokenUrl: + description: |- + (String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers. + The token endpoint of your OAuth2 provider. Required for Azure AD providers. + type: string type: object type: array type: object @@ -36591,6 +36937,236 @@ spec: for example because of an external controller is managing them, like an autoscaler. properties: + ldapSettings: + description: |- + (Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) + The LDAP settings set. Required for the ldap provider. + items: + properties: + allowSignUp: + description: |- + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + type: boolean + config: + description: |- + (Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) + The LDAP configuration. + items: + properties: + servers: + description: |- + (Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) + The LDAP servers configuration. + items: + properties: + attributes: + additionalProperties: + type: string + description: |- + (Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + type: object + x-kubernetes-map-type: granular + bindDn: + description: |- + (String) The search user bind DN. + The search user bind DN. + type: string + bindPasswordSecretRef: + description: |- + (String, Sensitive) The search user bind password. + The search user bind password. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + clientCert: + description: |- + (String) The path to the client certificate. + The path to the client certificate. + type: string + clientCertValue: + description: |- + (String) The Base64 encoded value of the client certificate. + The Base64 encoded value of the client certificate. + type: string + clientKeySecretRef: + description: |- + (String, Sensitive) The path to the client private key. + The path to the client private key. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + clientKeyValueSecretRef: + description: |- + (String, Sensitive) The Base64 encoded value of the client private key. + The Base64 encoded value of the client private key. + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object + groupMappings: + description: |- + (Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) + For mapping an LDAP group to a Grafana organization and role. + items: + properties: + grafanaAdmin: + description: |- + (Boolean) If set to true, it makes the user of group_dn Grafana server admin. + If set to true, it makes the user of group_dn Grafana server admin. + type: boolean + groupDn: + description: |- + (String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + type: string + orgId: + description: |- + (Number) The Grafana organization database id. + The Grafana organization database id. + type: number + orgRole: + description: |- + (String) Assign users of group_dn the organization role Admin, Editor, or Viewer. + Assign users of group_dn the organization role Admin, Editor, or Viewer. + type: string + type: object + type: array + groupSearchBaseDns: + description: |- + (List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. + An array of the base DNs to search through for groups. Typically uses ou=groups. + items: + type: string + type: array + groupSearchFilter: + description: |- + (String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + type: string + groupSearchFilterUserAttribute: + description: |- + (String) The %s in the search filter will be replaced with the attribute defined in this field. + The %s in the search filter will be replaced with the attribute defined in this field. + type: string + host: + description: |- + (String) The LDAP server host. + The LDAP server host. + type: string + minTlsVersion: + description: |- + (String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + type: string + port: + description: |- + (Number) The LDAP server port. + The LDAP server port. + type: number + rootCaCert: + description: |- + (String) The path to the root CA certificate. + The path to the root CA certificate. + type: string + rootCaCertValue: + description: |- + (List of String) The Base64 encoded values of the root CA certificates. + The Base64 encoded values of the root CA certificates. + items: + type: string + type: array + searchBaseDns: + description: |- + (List of String) An array of base DNs to search through. + An array of base DNs to search through. + items: + type: string + type: array + searchFilter: + description: |- + (String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + type: string + sslSkipVerify: + description: |- + (Boolean) If set to true, the SSL cert validation will be skipped. + If set to true, the SSL cert validation will be skipped. + type: boolean + startTls: + description: |- + (Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS. + If set to true, use LDAP with STARTTLS instead of LDAPS. + type: boolean + timeout: + description: |- + (Number) The timeout in seconds for connecting to the LDAP host. + The timeout in seconds for connecting to the LDAP host. + type: number + tlsCiphers: + description: |- + (List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + items: + type: string + type: array + useSsl: + description: |- + (Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + type: boolean + type: object + type: array + type: object + type: array + enabled: + description: |- + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. + Define whether this configuration is enabled for LDAP. Defaults to `true`. + type: boolean + skipOrgRoleSync: + description: |- + (Boolean) Prevent synchronizing users’ organization roles from LDAP. + Prevent synchronizing users’ organization roles from LDAP. + type: boolean + type: object + type: array oauth2Settings: description: |- (Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema) @@ -36604,7 +37180,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. If not enabled, only existing Grafana users can log in using OAuth. type: boolean allowedDomains: @@ -36701,7 +37277,7 @@ spec: type: boolean enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for the specified provider. Defaults to `true`. type: boolean groupsAttributePath: @@ -36729,6 +37305,16 @@ spec: (String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. type: string + orgAttributePath: + description: |- + (String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + type: string + orgMapping: + description: |- + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + List of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + type: string roleAttributePath: description: |- (String) JMESPath expression to use for Grafana role lookup. @@ -36751,7 +37337,7 @@ spec: type: string skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean teamIds: @@ -36808,8 +37394,8 @@ spec: type: array providerName: description: |- - (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. - The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. + (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. + The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. type: string samlSettings: description: |- @@ -36824,7 +37410,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. Whether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML. type: boolean allowedOrganizations: @@ -36891,11 +37477,26 @@ spec: - name - namespace type: object + clientId: + description: |- + (String) The client Id of your OAuth2 app. + The client Id of your OAuth2 app. + type: string + clientSecret: + description: |- + (String, Sensitive) The client secret of your OAuth2 app. + The client secret of your OAuth2 app. + type: string enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for SAML. Defaults to `true`. type: boolean + forceUseGraphApi: + description: |- + (Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + type: boolean idpMetadata: description: |- encoded string for the IdP SAML metadata XML. @@ -36933,7 +37534,7 @@ spec: type: string orgMapping: description: |- - or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. List of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. type: string privateKeyPath: @@ -37002,9 +37603,14 @@ spec: type: boolean skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean + tokenUrl: + description: |- + (String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers. + The token endpoint of your OAuth2 provider. Required for Azure AD providers. + type: string type: object type: array type: object @@ -37188,6 +37794,179 @@ spec: id: description: (String) The ID of this resource. type: string + ldapSettings: + description: |- + (Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema) + The LDAP settings set. Required for the ldap provider. + items: + properties: + allowSignUp: + description: |- + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. + type: boolean + config: + description: |- + (Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema) + The LDAP configuration. + items: + properties: + servers: + description: |- + (Block List, Min: 1) The LDAP servers configuration. (see below for nested schema) + The LDAP servers configuration. + items: + properties: + attributes: + additionalProperties: + type: string + description: |- + (Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username. + type: object + x-kubernetes-map-type: granular + bindDn: + description: |- + (String) The search user bind DN. + The search user bind DN. + type: string + clientCert: + description: |- + (String) The path to the client certificate. + The path to the client certificate. + type: string + clientCertValue: + description: |- + (String) The Base64 encoded value of the client certificate. + The Base64 encoded value of the client certificate. + type: string + groupMappings: + description: |- + (Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema) + For mapping an LDAP group to a Grafana organization and role. + items: + properties: + grafanaAdmin: + description: |- + (Boolean) If set to true, it makes the user of group_dn Grafana server admin. + If set to true, it makes the user of group_dn Grafana server admin. + type: boolean + groupDn: + description: |- + (String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*"). + type: string + orgId: + description: |- + (Number) The Grafana organization database id. + The Grafana organization database id. + type: number + orgRole: + description: |- + (String) Assign users of group_dn the organization role Admin, Editor, or Viewer. + Assign users of group_dn the organization role Admin, Editor, or Viewer. + type: string + type: object + type: array + groupSearchBaseDns: + description: |- + (List of String) An array of the base DNs to search through for groups. Typically uses ou=groups. + An array of the base DNs to search through for groups. Typically uses ou=groups. + items: + type: string + type: array + groupSearchFilter: + description: |- + (String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available). + type: string + groupSearchFilterUserAttribute: + description: |- + (String) The %s in the search filter will be replaced with the attribute defined in this field. + The %s in the search filter will be replaced with the attribute defined in this field. + type: string + host: + description: |- + (String) The LDAP server host. + The LDAP server host. + type: string + minTlsVersion: + description: |- + (String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3. + type: string + port: + description: |- + (Number) The LDAP server port. + The LDAP server port. + type: number + rootCaCert: + description: |- + (String) The path to the root CA certificate. + The path to the root CA certificate. + type: string + rootCaCertValue: + description: |- + (List of String) The Base64 encoded values of the root CA certificates. + The Base64 encoded values of the root CA certificates. + items: + type: string + type: array + searchBaseDns: + description: |- + (List of String) An array of base DNs to search through. + An array of base DNs to search through. + items: + type: string + type: array + searchFilter: + description: |- + (String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)". + type: string + sslSkipVerify: + description: |- + (Boolean) If set to true, the SSL cert validation will be skipped. + If set to true, the SSL cert validation will be skipped. + type: boolean + startTls: + description: |- + (Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS. + If set to true, use LDAP with STARTTLS instead of LDAPS. + type: boolean + timeout: + description: |- + (Number) The timeout in seconds for connecting to the LDAP host. + The timeout in seconds for connecting to the LDAP host. + type: number + tlsCiphers: + description: |- + (List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go. + items: + type: string + type: array + useSsl: + description: |- + (Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS). + type: boolean + type: object + type: array + type: object + type: array + enabled: + description: |- + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. + Define whether this configuration is enabled for LDAP. Defaults to `true`. + type: boolean + skipOrgRoleSync: + description: |- + (Boolean) Prevent synchronizing users’ organization roles from LDAP. + Prevent synchronizing users’ organization roles from LDAP. + type: boolean + type: object + type: array oauth2Settings: description: |- (Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema) @@ -37201,7 +37980,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. If not enabled, only existing Grafana users can log in using OAuth. type: boolean allowedDomains: @@ -37279,7 +38058,7 @@ spec: type: boolean enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for the specified provider. Defaults to `true`. type: boolean groupsAttributePath: @@ -37307,6 +38086,16 @@ spec: (String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth. type: string + orgAttributePath: + description: |- + (String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta. + type: string + orgMapping: + description: |- + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + List of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. + type: string roleAttributePath: description: |- (String) JMESPath expression to use for Grafana role lookup. @@ -37329,7 +38118,7 @@ spec: type: string skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean teamIds: @@ -37386,8 +38175,8 @@ spec: type: array providerName: description: |- - (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. - The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml. + (String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. + The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap. type: string samlSettings: description: |- @@ -37402,7 +38191,7 @@ spec: type: boolean allowSignUp: description: |- - (Boolean) If not enabled, only existing Grafana users can log in using OAuth. + (Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP. Whether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML. type: boolean allowedOrganizations: @@ -37450,11 +38239,26 @@ spec: (String) Path for the SP X.509 certificate. Path for the SP X.509 certificate. type: string + clientId: + description: |- + (String) The client Id of your OAuth2 app. + The client Id of your OAuth2 app. + type: string + clientSecret: + description: |- + (String, Sensitive) The client secret of your OAuth2 app. + The client secret of your OAuth2 app. + type: string enabled: description: |- - (Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true. + (Boolean) Define whether this configuration is enabled for LDAP. Defaults to true. Define whether this configuration is enabled for SAML. Defaults to `true`. type: boolean + forceUseGraphApi: + description: |- + (Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token. + type: boolean idpMetadata: description: |- encoded string for the IdP SAML metadata XML. @@ -37492,7 +38296,7 @@ spec: type: string orgMapping: description: |- - or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. + or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin. List of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin. type: string privateKeyPath: @@ -37542,9 +38346,14 @@ spec: type: boolean skipOrgRoleSync: description: |- - (Boolean) Prevent synchronizing users’ organization roles from your IdP. + (Boolean) Prevent synchronizing users’ organization roles from LDAP. Prevent synchronizing users’ organization roles from your IdP. type: boolean + tokenUrl: + description: |- + (String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers. + The token endpoint of your OAuth2 provider. Required for Azure AD providers. + type: string type: object type: array type: object @@ -38518,7 +39327,8 @@ spec: API https://grafana.com/docs/grafana/latest/developers/http_api/user/ This resource represents an instance-scoped resource and uses Grafana's admin APIs. It does not work with API tokens or service accounts which are org-scoped. - You must use basic auth. + You must use basic auth. This resource is also not compatible with Grafana + Cloud, as it does not allow basic auth. properties: apiVersion: description: |- @@ -39030,12 +39840,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39052,12 +39864,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39068,12 +39882,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39086,12 +39902,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39108,12 +39926,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39124,12 +39944,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39243,11 +40065,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the value - of the query is above the objective, the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39323,6 +40148,11 @@ spec: type: string type: object type: array + searchExpression: + description: |- + (String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + type: string type: object initProvider: description: |- @@ -39369,12 +40199,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39391,12 +40223,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39407,12 +40241,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39425,12 +40261,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39447,12 +40285,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39463,12 +40303,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39582,11 +40424,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the value - of the query is above the objective, the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39662,6 +40507,11 @@ spec: type: string type: object type: array + searchExpression: + description: |- + (String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + type: string type: object managementPolicies: default: @@ -39884,12 +40734,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39906,12 +40758,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39922,12 +40776,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39940,12 +40796,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the - value of the query is above the objective, the SLO - is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39962,12 +40820,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -39978,12 +40838,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. - If the value of the query is above the objective, - the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -40024,11 +40886,14 @@ spec: items: properties: key: - description: (String) + description: |- + (String) Key for filtering and identification + Key for filtering and identification type: string value: - description: (Number) Value between 0 and 1. If the value - of the query is above the objective, the SLO is met. + description: |- + (Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met. + Templatable value type: string type: object type: array @@ -40104,6 +40969,11 @@ spec: type: string type: object type: array + searchExpression: + description: |- + (String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench. + type: string type: object conditions: description: Conditions of the resource. @@ -40493,11 +41363,25 @@ spec: Basic auth settings. items: properties: - password: + passwordSecretRef: description: |- - (String) Basic auth password. + (String, Sensitive) Basic auth password. Basic auth password. - type: string + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object username: description: |- (String) Basic auth username. @@ -40505,11 +41389,25 @@ spec: type: string type: object type: array - bearerToken: + bearerTokenSecretRef: description: |- - (String) Token for use with bearer authorization header. + (String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header. - type: string + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object body: description: |- (String) The body of the HTTP request used in probe. @@ -41273,23 +42171,53 @@ spec: Basic auth settings. items: properties: - password: + passwordSecretRef: description: |- - (String) Basic auth password. + (String, Sensitive) Basic auth password. Basic auth password. - type: string + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object username: description: |- (String) Basic auth username. Basic auth username. type: string + required: + - passwordSecretRef type: object type: array - bearerToken: + bearerTokenSecretRef: description: |- - (String) Token for use with bearer authorization header. + (String, Sensitive) Token for use with bearer authorization header. Token for use with bearer authorization header. - type: string + properties: + key: + description: The key to select. + type: string + name: + description: Name of the secret. + type: string + namespace: + description: Namespace of the secret. + type: string + required: + - key + - name + - namespace + type: object body: description: |- (String) The body of the HTTP request used in probe. @@ -42213,11 +43141,6 @@ spec: Basic auth settings. items: properties: - password: - description: |- - (String) Basic auth password. - Basic auth password. - type: string username: description: |- (String) Basic auth username. @@ -42225,11 +43148,6 @@ spec: type: string type: object type: array - bearerToken: - description: |- - (String) Token for use with bearer authorization header. - Token for use with bearer authorization header. - type: string body: description: |- (String) The body of the HTTP request used in probe. diff --git a/grafanaplane/alerting/v1alpha1/ruleGroup/spec/parameters.libsonnet b/grafanaplane/alerting/v1alpha1/ruleGroup/spec/parameters.libsonnet index f8bab06..1c0723b 100644 --- a/grafanaplane/alerting/v1alpha1/ruleGroup/spec/parameters.libsonnet +++ b/grafanaplane/alerting/v1alpha1/ruleGroup/spec/parameters.libsonnet @@ -520,11 +520,11 @@ rule+: { '#': { help: '', name: 'rule' }, - '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.' } }, + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.' } }, withAnnotations(value): { annotations: value, }, - '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.' } }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.' } }, withAnnotationsMixin(value): { annotations+: value, }, @@ -1297,11 +1297,11 @@ rule+: { '#': { help: '', name: 'rule' }, - '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.' } }, + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.' } }, withAnnotations(value): { annotations: value, }, - '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.' } }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.' } }, withAnnotationsMixin(value): { annotations+: value, }, diff --git a/grafanaplane/compositions.libsonnet b/grafanaplane/compositions.libsonnet index 2d0f1ab..c6fff65 100644 --- a/grafanaplane/compositions.libsonnet +++ b/grafanaplane/compositions.libsonnet @@ -8687,7 +8687,7 @@ additionalProperties: { type: 'string', }, - description: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.', + description: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.', type: 'object', 'x-kubernetes-map-type': 'granular', }, @@ -9071,7 +9071,7 @@ additionalProperties: { type: 'string', }, - description: 'value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.', + description: 'value pairs of metadata to attach to the alert rule. They add additional information, such as a summary or runbook_url, to help identify and investigate alerts. The dashboardUId and panelId annotations, which link alerts to a panel, must be set together. Defaults to map[].\nKey-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.', type: 'object', 'x-kubernetes-map-type': 'granular', }, @@ -20588,6 +20588,11 @@ toFieldPath: 'spec.forProvider.position', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.forProvider.severity', + toFieldPath: 'spec.forProvider.severity', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.forProvider.type', toFieldPath: 'spec.forProvider.type', @@ -20758,6 +20763,11 @@ toFieldPath: 'spec.initProvider.position', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.initProvider.severity', + toFieldPath: 'spec.initProvider.severity', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.initProvider.type', toFieldPath: 'spec.initProvider.type', @@ -20972,7 +20982,7 @@ type: 'object', }, duration: { - description: '(Number) The duration of delay for wait type step.\nThe duration of delay for wait type step.', + description: '86400) seconds\nThe duration of delay for wait type step. (60-86400) seconds', type: 'number', }, escalationChainId: { @@ -21175,8 +21185,12 @@ description: '(Number) The position of the escalation step (starts from 0).\nThe position of the escalation step (starts from 0).', type: 'number', }, + severity: { + description: '(String) The severity of the incident for declare_incident type step.\nThe severity of the incident for declare_incident type step.', + type: 'string', + }, type: { - description: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members', + description: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident', type: 'string', }, }, @@ -21266,7 +21280,7 @@ type: 'object', }, duration: { - description: '(Number) The duration of delay for wait type step.\nThe duration of delay for wait type step.', + description: '86400) seconds\nThe duration of delay for wait type step. (60-86400) seconds', type: 'number', }, escalationChainId: { @@ -21469,8 +21483,12 @@ description: '(Number) The position of the escalation step (starts from 0).\nThe position of the escalation step (starts from 0).', type: 'number', }, + severity: { + description: '(String) The severity of the incident for declare_incident type step.\nThe severity of the incident for declare_incident type step.', + type: 'string', + }, type: { - description: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members', + description: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident', type: 'string', }, }, @@ -22435,7 +22453,7 @@ type: 'string', }, microsoftTeams: { - description: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.', + description: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.', items: { properties: { imageUrl: { @@ -22455,6 +22473,23 @@ }, type: 'array', }, + mobileApp: { + description: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.', + items: { + properties: { + message: { + description: '(String) Template for Alert message.\nTemplate for Alert message.', + type: 'string', + }, + title: { + description: '(String) Template for Alert title.\nTemplate for Alert title.', + type: 'string', + }, + }, + type: 'object', + }, + type: 'array', + }, phoneCall: { description: '(Block List, Max: 1) Templates for Phone Call. (see below for nested schema)\nTemplates for Phone Call.', items: { @@ -22745,7 +22780,7 @@ type: 'string', }, microsoftTeams: { - description: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.', + description: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.', items: { properties: { imageUrl: { @@ -22765,6 +22800,23 @@ }, type: 'array', }, + mobileApp: { + description: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.', + items: { + properties: { + message: { + description: '(String) Template for Alert message.\nTemplate for Alert message.', + type: 'string', + }, + title: { + description: '(String) Template for Alert title.\nTemplate for Alert title.', + type: 'string', + }, + }, + type: 'object', + }, + type: 'array', + }, phoneCall: { description: '(Block List, Max: 1) Templates for Phone Call. (see below for nested schema)\nTemplates for Phone Call.', items: { @@ -23165,6 +23217,11 @@ toFieldPath: 'spec.forProvider.type', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.forProvider.until', + toFieldPath: 'spec.forProvider.until', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.forProvider.users', toFieldPath: 'spec.forProvider.users', @@ -23245,6 +23302,11 @@ toFieldPath: 'spec.initProvider.type', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.initProvider.until', + toFieldPath: 'spec.initProvider.until', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.initProvider.users', toFieldPath: 'spec.initProvider.users', @@ -23457,6 +23519,10 @@ description: "(String) The shift's type. Can be rolling_users, recurrent_event, single_event\nThe shift's type. Can be rolling_users, recurrent_event, single_event", type: 'string', }, + until: { + description: "call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")\nThe end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")", + type: 'string', + }, users: { description: 'call users (for single_event and recurrent_event event type).\nThe list of on-call users (for single_event and recurrent_event event type).', items: { @@ -23549,6 +23615,10 @@ description: "(String) The shift's type. Can be rolling_users, recurrent_event, single_event\nThe shift's type. Can be rolling_users, recurrent_event, single_event", type: 'string', }, + until: { + description: "call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")\nThe end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")", + type: 'string', + }, users: { description: 'call users (for single_event and recurrent_event event type).\nThe list of on-call users (for single_event and recurrent_event event type).', items: { @@ -38856,6 +38926,11 @@ toFieldPath: 'spec.deletionPolicy', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.forProvider.ldapSettings', + toFieldPath: 'spec.forProvider.ldapSettings', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.forProvider.oauth2Settings', toFieldPath: 'spec.forProvider.oauth2Settings', @@ -38871,6 +38946,11 @@ toFieldPath: 'spec.forProvider.samlSettings', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.initProvider.ldapSettings', + toFieldPath: 'spec.initProvider.ldapSettings', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.initProvider.oauth2Settings', toFieldPath: 'spec.initProvider.oauth2Settings', @@ -39014,6 +39094,231 @@ }, forProvider: { properties: { + ldapSettings: { + description: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.', + items: { + properties: { + allowSignUp: { + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.', + type: 'boolean', + }, + config: { + description: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.', + items: { + properties: { + servers: { + description: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.', + items: { + properties: { + attributes: { + additionalProperties: { + type: 'string', + }, + description: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.', + type: 'object', + 'x-kubernetes-map-type': 'granular', + }, + bindDn: { + description: '(String) The search user bind DN.\nThe search user bind DN.', + type: 'string', + }, + bindPasswordSecretRef: { + description: '(String, Sensitive) The search user bind password.\nThe search user bind password.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + clientCert: { + description: '(String) The path to the client certificate.\nThe path to the client certificate.', + type: 'string', + }, + clientCertValue: { + description: '(String) The Base64 encoded value of the client certificate.\nThe Base64 encoded value of the client certificate.', + type: 'string', + }, + clientKeySecretRef: { + description: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + clientKeyValueSecretRef: { + description: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + groupMappings: { + description: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.', + items: { + properties: { + grafanaAdmin: { + description: '(Boolean) If set to true, it makes the user of group_dn Grafana server admin.\nIf set to true, it makes the user of group_dn Grafana server admin.', + type: 'boolean', + }, + groupDn: { + description: '(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").\nLDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").', + type: 'string', + }, + orgId: { + description: '(Number) The Grafana organization database id.\nThe Grafana organization database id.', + type: 'number', + }, + orgRole: { + description: '(String) Assign users of group_dn the organization role Admin, Editor, or Viewer.\nAssign users of group_dn the organization role Admin, Editor, or Viewer.', + type: 'string', + }, + }, + type: 'object', + }, + type: 'array', + }, + groupSearchBaseDns: { + description: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.', + items: { + type: 'string', + }, + type: 'array', + }, + groupSearchFilter: { + description: '(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).\nGroup search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).', + type: 'string', + }, + groupSearchFilterUserAttribute: { + description: '(String) The %s in the search filter will be replaced with the attribute defined in this field.\nThe %s in the search filter will be replaced with the attribute defined in this field.', + type: 'string', + }, + host: { + description: '(String) The LDAP server host.\nThe LDAP server host.', + type: 'string', + }, + minTlsVersion: { + description: '(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.\nMinimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.', + type: 'string', + }, + port: { + description: '(Number) The LDAP server port.\nThe LDAP server port.', + type: 'number', + }, + rootCaCert: { + description: '(String) The path to the root CA certificate.\nThe path to the root CA certificate.', + type: 'string', + }, + rootCaCertValue: { + description: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.', + items: { + type: 'string', + }, + type: 'array', + }, + searchBaseDns: { + description: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.', + items: { + type: 'string', + }, + type: 'array', + }, + searchFilter: { + description: '(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".\nThe user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".', + type: 'string', + }, + sslSkipVerify: { + description: '(Boolean) If set to true, the SSL cert validation will be skipped.\nIf set to true, the SSL cert validation will be skipped.', + type: 'boolean', + }, + startTls: { + description: '(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS.\nIf set to true, use LDAP with STARTTLS instead of LDAPS.', + type: 'boolean', + }, + timeout: { + description: '(Number) The timeout in seconds for connecting to the LDAP host.\nThe timeout in seconds for connecting to the LDAP host.', + type: 'number', + }, + tlsCiphers: { + description: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.', + items: { + type: 'string', + }, + type: 'array', + }, + useSsl: { + description: '(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).\nSet to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).', + type: 'boolean', + }, + }, + type: 'object', + }, + type: 'array', + }, + }, + type: 'object', + }, + type: 'array', + }, + enabled: { + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for LDAP. Defaults to `true`.', + type: 'boolean', + }, + skipOrgRoleSync: { + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from LDAP.', + type: 'boolean', + }, + }, + type: 'object', + }, + type: 'array', + }, oauth2Settings: { description: '(Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema)\nThe OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers.', items: { @@ -39023,7 +39328,7 @@ type: 'boolean', }, allowSignUp: { - description: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nIf not enabled, only existing Grafana users can log in using OAuth.', + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nIf not enabled, only existing Grafana users can log in using OAuth.', type: 'boolean', }, allowedDomains: { @@ -39110,7 +39415,7 @@ type: 'boolean', }, enabled: { - description: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.', + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.', type: 'boolean', }, groupsAttributePath: { @@ -39133,6 +39438,14 @@ description: '(String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth.\nJMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth.', type: 'string', }, + orgAttributePath: { + description: '(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.\nJMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.', + type: 'string', + }, + orgMapping: { + description: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.', + type: 'string', + }, roleAttributePath: { description: '(String) JMESPath expression to use for Grafana role lookup.\nJMESPath expression to use for Grafana role lookup.', type: 'string', @@ -39150,7 +39463,7 @@ type: 'string', }, skipOrgRoleSync: { - description: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.', + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.', type: 'boolean', }, teamIds: { @@ -39199,7 +39512,7 @@ type: 'array', }, providerName: { - description: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.', + description: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.', type: 'string', }, samlSettings: { @@ -39211,7 +39524,7 @@ type: 'boolean', }, allowSignUp: { - description: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.', + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.', type: 'boolean', }, allowedOrganizations: { @@ -39273,8 +39586,20 @@ ], type: 'object', }, + clientId: { + description: '(String) The client Id of your OAuth2 app.\nThe client Id of your OAuth2 app.', + type: 'string', + }, + clientSecret: { + description: '(String, Sensitive) The client secret of your OAuth2 app.\nThe client secret of your OAuth2 app.', + type: 'string', + }, enabled: { - description: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.', + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.', + type: 'boolean', + }, + forceUseGraphApi: { + description: '(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.\nIf enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.', type: 'boolean', }, idpMetadata: { @@ -39306,7 +39631,7 @@ type: 'string', }, orgMapping: { - description: 'or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.', + description: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.', type: 'string', }, privateKeyPath: { @@ -39369,9 +39694,13 @@ type: 'boolean', }, skipOrgRoleSync: { - description: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.', + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.', type: 'boolean', }, + tokenUrl: { + description: '(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers.\nThe token endpoint of your OAuth2 provider. Required for Azure AD providers.', + type: 'string', + }, }, type: 'object', }, @@ -39383,6 +39712,231 @@ initProvider: { description: 'THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.', properties: { + ldapSettings: { + description: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.', + items: { + properties: { + allowSignUp: { + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.', + type: 'boolean', + }, + config: { + description: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.', + items: { + properties: { + servers: { + description: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.', + items: { + properties: { + attributes: { + additionalProperties: { + type: 'string', + }, + description: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.', + type: 'object', + 'x-kubernetes-map-type': 'granular', + }, + bindDn: { + description: '(String) The search user bind DN.\nThe search user bind DN.', + type: 'string', + }, + bindPasswordSecretRef: { + description: '(String, Sensitive) The search user bind password.\nThe search user bind password.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + clientCert: { + description: '(String) The path to the client certificate.\nThe path to the client certificate.', + type: 'string', + }, + clientCertValue: { + description: '(String) The Base64 encoded value of the client certificate.\nThe Base64 encoded value of the client certificate.', + type: 'string', + }, + clientKeySecretRef: { + description: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + clientKeyValueSecretRef: { + description: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', + }, + groupMappings: { + description: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.', + items: { + properties: { + grafanaAdmin: { + description: '(Boolean) If set to true, it makes the user of group_dn Grafana server admin.\nIf set to true, it makes the user of group_dn Grafana server admin.', + type: 'boolean', + }, + groupDn: { + description: '(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").\nLDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").', + type: 'string', + }, + orgId: { + description: '(Number) The Grafana organization database id.\nThe Grafana organization database id.', + type: 'number', + }, + orgRole: { + description: '(String) Assign users of group_dn the organization role Admin, Editor, or Viewer.\nAssign users of group_dn the organization role Admin, Editor, or Viewer.', + type: 'string', + }, + }, + type: 'object', + }, + type: 'array', + }, + groupSearchBaseDns: { + description: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.', + items: { + type: 'string', + }, + type: 'array', + }, + groupSearchFilter: { + description: '(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).\nGroup search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).', + type: 'string', + }, + groupSearchFilterUserAttribute: { + description: '(String) The %s in the search filter will be replaced with the attribute defined in this field.\nThe %s in the search filter will be replaced with the attribute defined in this field.', + type: 'string', + }, + host: { + description: '(String) The LDAP server host.\nThe LDAP server host.', + type: 'string', + }, + minTlsVersion: { + description: '(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.\nMinimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.', + type: 'string', + }, + port: { + description: '(Number) The LDAP server port.\nThe LDAP server port.', + type: 'number', + }, + rootCaCert: { + description: '(String) The path to the root CA certificate.\nThe path to the root CA certificate.', + type: 'string', + }, + rootCaCertValue: { + description: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.', + items: { + type: 'string', + }, + type: 'array', + }, + searchBaseDns: { + description: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.', + items: { + type: 'string', + }, + type: 'array', + }, + searchFilter: { + description: '(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".\nThe user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".', + type: 'string', + }, + sslSkipVerify: { + description: '(Boolean) If set to true, the SSL cert validation will be skipped.\nIf set to true, the SSL cert validation will be skipped.', + type: 'boolean', + }, + startTls: { + description: '(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS.\nIf set to true, use LDAP with STARTTLS instead of LDAPS.', + type: 'boolean', + }, + timeout: { + description: '(Number) The timeout in seconds for connecting to the LDAP host.\nThe timeout in seconds for connecting to the LDAP host.', + type: 'number', + }, + tlsCiphers: { + description: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.', + items: { + type: 'string', + }, + type: 'array', + }, + useSsl: { + description: '(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).\nSet to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).', + type: 'boolean', + }, + }, + type: 'object', + }, + type: 'array', + }, + }, + type: 'object', + }, + type: 'array', + }, + enabled: { + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for LDAP. Defaults to `true`.', + type: 'boolean', + }, + skipOrgRoleSync: { + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from LDAP.', + type: 'boolean', + }, + }, + type: 'object', + }, + type: 'array', + }, oauth2Settings: { description: '(Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema)\nThe OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers.', items: { @@ -39392,7 +39946,7 @@ type: 'boolean', }, allowSignUp: { - description: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nIf not enabled, only existing Grafana users can log in using OAuth.', + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nIf not enabled, only existing Grafana users can log in using OAuth.', type: 'boolean', }, allowedDomains: { @@ -39479,7 +40033,7 @@ type: 'boolean', }, enabled: { - description: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.', + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.', type: 'boolean', }, groupsAttributePath: { @@ -39502,6 +40056,14 @@ description: '(String) JMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth.\nJMESPath expression to use for user name lookup from the user ID token. This name will be used as the user’s display name. Only applicable to Generic OAuth.', type: 'string', }, + orgAttributePath: { + description: '(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.\nJMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.', + type: 'string', + }, + orgMapping: { + description: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.', + type: 'string', + }, roleAttributePath: { description: '(String) JMESPath expression to use for Grafana role lookup.\nJMESPath expression to use for Grafana role lookup.', type: 'string', @@ -39519,7 +40081,7 @@ type: 'string', }, skipOrgRoleSync: { - description: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.', + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.', type: 'boolean', }, teamIds: { @@ -39568,7 +40130,7 @@ type: 'array', }, providerName: { - description: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.', + description: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.', type: 'string', }, samlSettings: { @@ -39580,7 +40142,7 @@ type: 'boolean', }, allowSignUp: { - description: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.', + description: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.', type: 'boolean', }, allowedOrganizations: { @@ -39642,8 +40204,20 @@ ], type: 'object', }, + clientId: { + description: '(String) The client Id of your OAuth2 app.\nThe client Id of your OAuth2 app.', + type: 'string', + }, + clientSecret: { + description: '(String, Sensitive) The client secret of your OAuth2 app.\nThe client secret of your OAuth2 app.', + type: 'string', + }, enabled: { - description: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.', + description: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.', + type: 'boolean', + }, + forceUseGraphApi: { + description: '(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.\nIf enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.', type: 'boolean', }, idpMetadata: { @@ -39675,7 +40249,7 @@ type: 'string', }, orgMapping: { - description: 'or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.', + description: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.', type: 'string', }, privateKeyPath: { @@ -39738,9 +40312,13 @@ type: 'boolean', }, skipOrgRoleSync: { - description: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.', + description: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.', type: 'boolean', }, + tokenUrl: { + description: '(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers.\nThe token endpoint of your OAuth2 provider. Required for Azure AD providers.', + type: 'string', + }, }, type: 'object', }, @@ -41495,6 +42073,11 @@ toFieldPath: 'spec.forProvider.query', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.forProvider.searchExpression', + toFieldPath: 'spec.forProvider.searchExpression', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.initProvider.alerting', toFieldPath: 'spec.initProvider.alerting', @@ -41535,6 +42118,11 @@ toFieldPath: 'spec.initProvider.query', type: 'FromCompositeFieldPath', }, + { + fromFieldPath: 'spec.parameters.initProvider.searchExpression', + toFieldPath: 'spec.initProvider.searchExpression', + type: 'FromCompositeFieldPath', + }, { fromFieldPath: 'spec.parameters.managementPolicies', toFieldPath: 'spec.managementPolicies', @@ -41685,11 +42273,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41706,11 +42294,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41723,11 +42311,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41745,11 +42333,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41766,11 +42354,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41783,11 +42371,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41907,11 +42495,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -41990,6 +42578,10 @@ }, type: 'array', }, + searchExpression: { + description: '(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.', + type: 'string', + }, }, type: 'object', }, @@ -42018,11 +42610,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42039,11 +42631,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42056,11 +42648,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42078,11 +42670,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42099,11 +42691,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42116,11 +42708,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42240,11 +42832,11 @@ items: { properties: { key: { - description: '(String)', + description: '(String) Key for filtering and identification\nKey for filtering and identification', type: 'string', }, value: { - description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.', + description: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value', type: 'string', }, }, @@ -42323,6 +42915,10 @@ }, type: 'array', }, + searchExpression: { + description: '(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.', + type: 'string', + }, }, type: 'object', }, @@ -43016,9 +43612,28 @@ description: '(Block Set, Max: 1) Basic auth settings. (see below for nested schema)\nBasic auth settings.', items: { properties: { - password: { - description: '(String) Basic auth password.\nBasic auth password.', - type: 'string', + passwordSecretRef: { + description: '(String, Sensitive) Basic auth password.\nBasic auth password.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', }, username: { description: '(String) Basic auth username.\nBasic auth username.', @@ -43029,9 +43644,28 @@ }, type: 'array', }, - bearerToken: { - description: '(String) Token for use with bearer authorization header.\nToken for use with bearer authorization header.', - type: 'string', + bearerTokenSecretRef: { + description: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', }, body: { description: '(String) The body of the HTTP request used in probe.\nThe body of the HTTP request used in probe.', @@ -43753,22 +44387,63 @@ description: '(Block Set, Max: 1) Basic auth settings. (see below for nested schema)\nBasic auth settings.', items: { properties: { - password: { - description: '(String) Basic auth password.\nBasic auth password.', - type: 'string', + passwordSecretRef: { + description: '(String, Sensitive) Basic auth password.\nBasic auth password.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', }, username: { description: '(String) Basic auth username.\nBasic auth username.', type: 'string', }, }, + required: [ + 'passwordSecretRef', + ], type: 'object', }, type: 'array', }, - bearerToken: { - description: '(String) Token for use with bearer authorization header.\nToken for use with bearer authorization header.', - type: 'string', + bearerTokenSecretRef: { + description: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.', + properties: { + key: { + description: 'The key to select.', + type: 'string', + }, + name: { + description: 'Name of the secret.', + type: 'string', + }, + namespace: { + description: 'Namespace of the secret.', + type: 'string', + }, + }, + required: [ + 'key', + 'name', + 'namespace', + ], + type: 'object', }, body: { description: '(String) The body of the HTTP request used in probe.\nThe body of the HTTP request used in probe.', diff --git a/grafanaplane/oncall/v1alpha1/escalation/spec/parameters.libsonnet b/grafanaplane/oncall/v1alpha1/escalation/spec/parameters.libsonnet index 21f48b3..b4b20d7 100644 --- a/grafanaplane/oncall/v1alpha1/escalation/spec/parameters.libsonnet +++ b/grafanaplane/oncall/v1alpha1/escalation/spec/parameters.libsonnet @@ -247,7 +247,7 @@ }, }, }, - '#withDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The duration of delay for wait type step.\nThe duration of delay for wait type step.' } }, + '#withDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '86400) seconds\nThe duration of delay for wait type step. (60-86400) seconds' } }, withDuration(value): { spec+: { parameters+: { @@ -797,7 +797,17 @@ }, }, }, - '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members' } }, + '#withSeverity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The severity of the incident for declare_incident type step.\nThe severity of the incident for declare_incident type step.' } }, + withSeverity(value): { + spec+: { + parameters+: { + forProvider+: { + severity: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident' } }, withType(value): { spec+: { parameters+: { @@ -1040,7 +1050,7 @@ }, }, }, - '#withDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The duration of delay for wait type step.\nThe duration of delay for wait type step.' } }, + '#withDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '86400) seconds\nThe duration of delay for wait type step. (60-86400) seconds' } }, withDuration(value): { spec+: { parameters+: { @@ -1590,7 +1600,17 @@ }, }, }, - '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members' } }, + '#withSeverity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The severity of the incident for declare_incident type step.\nThe severity of the incident for declare_incident type step.' } }, + withSeverity(value): { + spec+: { + parameters+: { + initProvider+: { + severity: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident\nThe type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_webhook, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation, notify_team_members, declare_incident' } }, withType(value): { spec+: { parameters+: { diff --git a/grafanaplane/oncall/v1alpha1/integration/spec/parameters.libsonnet b/grafanaplane/oncall/v1alpha1/integration/spec/parameters.libsonnet index 37dea62..6aa1f91 100644 --- a/grafanaplane/oncall/v1alpha1/integration/spec/parameters.libsonnet +++ b/grafanaplane/oncall/v1alpha1/integration/spec/parameters.libsonnet @@ -336,14 +336,14 @@ withGroupingKey(value): { groupingKey: value, }, - '#withMicrosoftTeams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.' } }, + '#withMicrosoftTeams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.' } }, withMicrosoftTeams(value): { microsoftTeams: (if std.isArray(value) then value else [value]), }, - '#withMicrosoftTeamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.' } }, + '#withMicrosoftTeamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.' } }, withMicrosoftTeamsMixin(value): { microsoftTeams+: (if std.isArray(value) @@ -366,6 +366,32 @@ title: value, }, }, + '#withMobileApp': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.' } }, + withMobileApp(value): { + mobileApp: + (if std.isArray(value) + then value + else [value]), + }, + '#withMobileAppMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.' } }, + withMobileAppMixin(value): { + mobileApp+: + (if std.isArray(value) + then value + else [value]), + }, + mobileApp+: + { + '#': { help: '', name: 'mobileApp' }, + '#withMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Template for Alert message.\nTemplate for Alert message.' } }, + withMessage(value): { + message: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Template for Alert title.\nTemplate for Alert title.' } }, + withTitle(value): { + title: value, + }, + }, '#withPhoneCall': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Phone Call. (see below for nested schema)\nTemplates for Phone Call.' } }, withPhoneCall(value): { phoneCall: @@ -841,14 +867,14 @@ withGroupingKey(value): { groupingKey: value, }, - '#withMicrosoftTeams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.' } }, + '#withMicrosoftTeams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.' } }, withMicrosoftTeams(value): { microsoftTeams: (if std.isArray(value) then value else [value]), }, - '#withMicrosoftTeamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. (see below for nested schema)\nTemplates for Microsoft Teams.' } }, + '#withMicrosoftTeamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Microsoft Teams. NOTE: Microsoft Teams templates are only available on Grafana Cloud. (see below for nested schema)\nTemplates for Microsoft Teams. **NOTE**: Microsoft Teams templates are only available on Grafana Cloud.' } }, withMicrosoftTeamsMixin(value): { microsoftTeams+: (if std.isArray(value) @@ -871,6 +897,32 @@ title: value, }, }, + '#withMobileApp': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.' } }, + withMobileApp(value): { + mobileApp: + (if std.isArray(value) + then value + else [value]), + }, + '#withMobileAppMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Mobile app push notifications. (see below for nested schema)\nTemplates for Mobile app push notifications.' } }, + withMobileAppMixin(value): { + mobileApp+: + (if std.isArray(value) + then value + else [value]), + }, + mobileApp+: + { + '#': { help: '', name: 'mobileApp' }, + '#withMessage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Template for Alert message.\nTemplate for Alert message.' } }, + withMessage(value): { + message: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Template for Alert title.\nTemplate for Alert title.' } }, + withTitle(value): { + title: value, + }, + }, '#withPhoneCall': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Max: 1) Templates for Phone Call. (see below for nested schema)\nTemplates for Phone Call.' } }, withPhoneCall(value): { phoneCall: diff --git a/grafanaplane/oncall/v1alpha1/onCallShift/spec/parameters.libsonnet b/grafanaplane/oncall/v1alpha1/onCallShift/spec/parameters.libsonnet index bf70e8a..c05a3dc 100644 --- a/grafanaplane/oncall/v1alpha1/onCallShift/spec/parameters.libsonnet +++ b/grafanaplane/oncall/v1alpha1/onCallShift/spec/parameters.libsonnet @@ -237,6 +237,16 @@ }, }, }, + '#withUntil': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")\nThe end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")" } }, + withUntil(value): { + spec+: { + parameters+: { + forProvider+: { + until: value, + }, + }, + }, + }, '#withUsers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'call users (for single_event and recurrent_event event type).\nThe list of on-call users (for single_event and recurrent_event event type).' } }, withUsers(value): { spec+: { @@ -496,6 +506,16 @@ }, }, }, + '#withUntil': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")\nThe end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example \"2020-09-05T08:00:00\")" } }, + withUntil(value): { + spec+: { + parameters+: { + initProvider+: { + until: value, + }, + }, + }, + }, '#withUsers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'call users (for single_event and recurrent_event event type).\nThe list of on-call users (for single_event and recurrent_event event type).' } }, withUsers(value): { spec+: { diff --git a/grafanaplane/oss/v1alpha1/ssoSettings/spec/parameters.libsonnet b/grafanaplane/oss/v1alpha1/ssoSettings/spec/parameters.libsonnet index 427d329..41e8934 100644 --- a/grafanaplane/oss/v1alpha1/ssoSettings/spec/parameters.libsonnet +++ b/grafanaplane/oss/v1alpha1/ssoSettings/spec/parameters.libsonnet @@ -33,6 +33,325 @@ }, forProvider+: { + '#withLdapSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.' } }, + withLdapSettings(value): { + spec+: { + parameters+: { + forProvider+: { + ldapSettings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLdapSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.' } }, + withLdapSettingsMixin(value): { + spec+: { + parameters+: { + forProvider+: { + ldapSettings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + ldapSettings+: + { + '#': { help: '', name: 'ldapSettings' }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.' } }, + withAllowSignUp(value=true): { + allowSignUp: value, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.' } }, + withConfig(value): { + config: + (if std.isArray(value) + then value + else [value]), + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.' } }, + withConfigMixin(value): { + config+: + (if std.isArray(value) + then value + else [value]), + }, + config+: + { + '#': { help: '', name: 'config' }, + '#withServers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.' } }, + withServers(value): { + servers: + (if std.isArray(value) + then value + else [value]), + }, + '#withServersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.' } }, + withServersMixin(value): { + servers+: + (if std.isArray(value) + then value + else [value]), + }, + servers+: + { + '#': { help: '', name: 'servers' }, + '#withAttributes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.' } }, + withAttributes(value): { + attributes: value, + }, + '#withAttributesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.' } }, + withAttributesMixin(value): { + attributes+: value, + }, + '#withBindDn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The search user bind DN.\nThe search user bind DN.' } }, + withBindDn(value): { + bindDn: value, + }, + '#withBindPasswordSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The search user bind password.\nThe search user bind password.' } }, + withBindPasswordSecretRef(value): { + bindPasswordSecretRef: value, + }, + '#withBindPasswordSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The search user bind password.\nThe search user bind password.' } }, + withBindPasswordSecretRefMixin(value): { + bindPasswordSecretRef+: value, + }, + bindPasswordSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + bindPasswordSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + bindPasswordSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + bindPasswordSecretRef+: { + namespace: value, + }, + }, + }, + '#withClientCert': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The path to the client certificate.\nThe path to the client certificate.' } }, + withClientCert(value): { + clientCert: value, + }, + '#withClientCertValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The Base64 encoded value of the client certificate.\nThe Base64 encoded value of the client certificate.' } }, + withClientCertValue(value): { + clientCertValue: value, + }, + '#withClientKeySecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.' } }, + withClientKeySecretRef(value): { + clientKeySecretRef: value, + }, + '#withClientKeySecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.' } }, + withClientKeySecretRefMixin(value): { + clientKeySecretRef+: value, + }, + clientKeySecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + clientKeySecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + clientKeySecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + clientKeySecretRef+: { + namespace: value, + }, + }, + }, + '#withClientKeyValueSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.' } }, + withClientKeyValueSecretRef(value): { + clientKeyValueSecretRef: value, + }, + '#withClientKeyValueSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.' } }, + withClientKeyValueSecretRefMixin(value): { + clientKeyValueSecretRef+: value, + }, + clientKeyValueSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + clientKeyValueSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + clientKeyValueSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + clientKeyValueSecretRef+: { + namespace: value, + }, + }, + }, + '#withGroupMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.' } }, + withGroupMappings(value): { + groupMappings: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.' } }, + withGroupMappingsMixin(value): { + groupMappings+: + (if std.isArray(value) + then value + else [value]), + }, + groupMappings+: + { + '#': { help: '', name: 'groupMappings' }, + '#withGrafanaAdmin': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, it makes the user of group_dn Grafana server admin.\nIf set to true, it makes the user of group_dn Grafana server admin.' } }, + withGrafanaAdmin(value=true): { + grafanaAdmin: value, + }, + '#withGroupDn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").\nLDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").' } }, + withGroupDn(value): { + groupDn: value, + }, + '#withOrgId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The Grafana organization database id.\nThe Grafana organization database id.' } }, + withOrgId(value): { + orgId: value, + }, + '#withOrgRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Assign users of group_dn the organization role Admin, Editor, or Viewer.\nAssign users of group_dn the organization role Admin, Editor, or Viewer.' } }, + withOrgRole(value): { + orgRole: value, + }, + }, + '#withGroupSearchBaseDns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.' } }, + withGroupSearchBaseDns(value): { + groupSearchBaseDns: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupSearchBaseDnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.' } }, + withGroupSearchBaseDnsMixin(value): { + groupSearchBaseDns+: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupSearchFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).\nGroup search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).' } }, + withGroupSearchFilter(value): { + groupSearchFilter: value, + }, + '#withGroupSearchFilterUserAttribute': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The %s in the search filter will be replaced with the attribute defined in this field.\nThe %s in the search filter will be replaced with the attribute defined in this field.' } }, + withGroupSearchFilterUserAttribute(value): { + groupSearchFilterUserAttribute: value, + }, + '#withHost': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The LDAP server host.\nThe LDAP server host.' } }, + withHost(value): { + host: value, + }, + '#withMinTlsVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.\nMinimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.' } }, + withMinTlsVersion(value): { + minTlsVersion: value, + }, + '#withPort': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The LDAP server port.\nThe LDAP server port.' } }, + withPort(value): { + port: value, + }, + '#withRootCaCert': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The path to the root CA certificate.\nThe path to the root CA certificate.' } }, + withRootCaCert(value): { + rootCaCert: value, + }, + '#withRootCaCertValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.' } }, + withRootCaCertValue(value): { + rootCaCertValue: + (if std.isArray(value) + then value + else [value]), + }, + '#withRootCaCertValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.' } }, + withRootCaCertValueMixin(value): { + rootCaCertValue+: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchBaseDns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.' } }, + withSearchBaseDns(value): { + searchBaseDns: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchBaseDnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.' } }, + withSearchBaseDnsMixin(value): { + searchBaseDns+: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".\nThe user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".' } }, + withSearchFilter(value): { + searchFilter: value, + }, + '#withSslSkipVerify': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, the SSL cert validation will be skipped.\nIf set to true, the SSL cert validation will be skipped.' } }, + withSslSkipVerify(value=true): { + sslSkipVerify: value, + }, + '#withStartTls': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS.\nIf set to true, use LDAP with STARTTLS instead of LDAPS.' } }, + withStartTls(value=true): { + startTls: value, + }, + '#withTimeout': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The timeout in seconds for connecting to the LDAP host.\nThe timeout in seconds for connecting to the LDAP host.' } }, + withTimeout(value): { + timeout: value, + }, + '#withTlsCiphers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.' } }, + withTlsCiphers(value): { + tlsCiphers: + (if std.isArray(value) + then value + else [value]), + }, + '#withTlsCiphersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.' } }, + withTlsCiphersMixin(value): { + tlsCiphers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withUseSsl': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).\nSet to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).' } }, + withUseSsl(value=true): { + useSsl: value, + }, + }, + }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for LDAP. Defaults to `true`.' } }, + withEnabled(value=true): { + enabled: value, + }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from LDAP.' } }, + withSkipOrgRoleSync(value=true): { + skipOrgRoleSync: value, + }, + }, '#withOauth2Settings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema)\nThe OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers.' } }, withOauth2Settings(value): { spec+: { @@ -66,7 +385,7 @@ withAllowAssignGrafanaAdmin(value=true): { allowAssignGrafanaAdmin: value, }, - '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nIf not enabled, only existing Grafana users can log in using OAuth.' } }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nIf not enabled, only existing Grafana users can log in using OAuth.' } }, withAllowSignUp(value=true): { allowSignUp: value, }, @@ -159,7 +478,7 @@ withEmptyScopes(value=true): { emptyScopes: value, }, - '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.' } }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.' } }, withEnabled(value=true): { enabled: value, }, @@ -183,6 +502,14 @@ withNameAttributePath(value): { nameAttributePath: value, }, + '#withOrgAttributePath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.\nJMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.' } }, + withOrgAttributePath(value): { + orgAttributePath: value, + }, + '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.' } }, + withOrgMapping(value): { + orgMapping: value, + }, '#withRoleAttributePath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) JMESPath expression to use for Grafana role lookup.\nJMESPath expression to use for Grafana role lookup.' } }, withRoleAttributePath(value): { roleAttributePath: value, @@ -199,7 +526,7 @@ withSignoutRedirectUrl(value): { signoutRedirectUrl: value, }, - '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, withSkipOrgRoleSync(value=true): { skipOrgRoleSync: value, }, @@ -244,7 +571,7 @@ useRefreshToken: value, }, }, - '#withProviderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.' } }, + '#withProviderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.' } }, withProviderName(value): { spec+: { parameters+: { @@ -287,7 +614,7 @@ withAllowIdpInitiated(value=true): { allowIdpInitiated: value, }, - '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.' } }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.' } }, withAllowSignUp(value=true): { allowSignUp: value, }, @@ -356,10 +683,22 @@ }, }, }, - '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.' } }, + '#withClientId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The client Id of your OAuth2 app.\nThe client Id of your OAuth2 app.' } }, + withClientId(value): { + clientId: value, + }, + '#withClientSecret': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String, Sensitive) The client secret of your OAuth2 app.\nThe client secret of your OAuth2 app.' } }, + withClientSecret(value): { + clientSecret: value, + }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.' } }, withEnabled(value=true): { enabled: value, }, + '#withForceUseGraphApi': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.\nIf enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.' } }, + withForceUseGraphApi(value=true): { + forceUseGraphApi: value, + }, '#withIdpMetadata': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'encoded string for the IdP SAML metadata XML.\nBase64-encoded string for the IdP SAML metadata XML.' } }, withIdpMetadata(value): { idpMetadata: value, @@ -388,7 +727,7 @@ withNameIdFormat(value): { nameIdFormat: value, }, - '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.' } }, + '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.' } }, withOrgMapping(value): { orgMapping: value, }, @@ -457,10 +796,14 @@ withSingleLogout(value=true): { singleLogout: value, }, - '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, withSkipOrgRoleSync(value=true): { skipOrgRoleSync: value, }, + '#withTokenUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers.\nThe token endpoint of your OAuth2 provider. Required for Azure AD providers.' } }, + withTokenUrl(value): { + tokenUrl: value, + }, }, }, '#withInitProvider': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.' } }, @@ -481,6 +824,325 @@ }, initProvider+: { + '#withLdapSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.' } }, + withLdapSettings(value): { + spec+: { + parameters+: { + initProvider+: { + ldapSettings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLdapSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The LDAP settings set. Required for the ldap provider. (see below for nested schema)\nThe LDAP settings set. Required for the ldap provider.' } }, + withLdapSettingsMixin(value): { + spec+: { + parameters+: { + initProvider+: { + ldapSettings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + ldapSettings+: + { + '#': { help: '', name: 'ldapSettings' }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.' } }, + withAllowSignUp(value=true): { + allowSignUp: value, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.' } }, + withConfig(value): { + config: + (if std.isArray(value) + then value + else [value]), + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1, Max: 1) The LDAP configuration. (see below for nested schema)\nThe LDAP configuration.' } }, + withConfigMixin(value): { + config+: + (if std.isArray(value) + then value + else [value]), + }, + config+: + { + '#': { help: '', name: 'config' }, + '#withServers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.' } }, + withServers(value): { + servers: + (if std.isArray(value) + then value + else [value]), + }, + '#withServersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List, Min: 1) The LDAP servers configuration. (see below for nested schema)\nThe LDAP servers configuration.' } }, + withServersMixin(value): { + servers+: + (if std.isArray(value) + then value + else [value]), + }, + servers+: + { + '#': { help: '', name: 'servers' }, + '#withAttributes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.' } }, + withAttributes(value): { + attributes: value, + }, + '#withAttributesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(Map of String) The LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.\nThe LDAP server attributes. The following attributes can be configured: email, member_of, name, surname, username.' } }, + withAttributesMixin(value): { + attributes+: value, + }, + '#withBindDn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The search user bind DN.\nThe search user bind DN.' } }, + withBindDn(value): { + bindDn: value, + }, + '#withBindPasswordSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The search user bind password.\nThe search user bind password.' } }, + withBindPasswordSecretRef(value): { + bindPasswordSecretRef: value, + }, + '#withBindPasswordSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The search user bind password.\nThe search user bind password.' } }, + withBindPasswordSecretRefMixin(value): { + bindPasswordSecretRef+: value, + }, + bindPasswordSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + bindPasswordSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + bindPasswordSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + bindPasswordSecretRef+: { + namespace: value, + }, + }, + }, + '#withClientCert': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The path to the client certificate.\nThe path to the client certificate.' } }, + withClientCert(value): { + clientCert: value, + }, + '#withClientCertValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The Base64 encoded value of the client certificate.\nThe Base64 encoded value of the client certificate.' } }, + withClientCertValue(value): { + clientCertValue: value, + }, + '#withClientKeySecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.' } }, + withClientKeySecretRef(value): { + clientKeySecretRef: value, + }, + '#withClientKeySecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The path to the client private key.\nThe path to the client private key.' } }, + withClientKeySecretRefMixin(value): { + clientKeySecretRef+: value, + }, + clientKeySecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + clientKeySecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + clientKeySecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + clientKeySecretRef+: { + namespace: value, + }, + }, + }, + '#withClientKeyValueSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.' } }, + withClientKeyValueSecretRef(value): { + clientKeyValueSecretRef: value, + }, + '#withClientKeyValueSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) The Base64 encoded value of the client private key.\nThe Base64 encoded value of the client private key.' } }, + withClientKeyValueSecretRefMixin(value): { + clientKeyValueSecretRef+: value, + }, + clientKeyValueSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + clientKeyValueSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + clientKeyValueSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + clientKeyValueSecretRef+: { + namespace: value, + }, + }, + }, + '#withGroupMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.' } }, + withGroupMappings(value): { + groupMappings: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block List) For mapping an LDAP group to a Grafana organization and role. (see below for nested schema)\nFor mapping an LDAP group to a Grafana organization and role.' } }, + withGroupMappingsMixin(value): { + groupMappings+: + (if std.isArray(value) + then value + else [value]), + }, + groupMappings+: + { + '#': { help: '', name: 'groupMappings' }, + '#withGrafanaAdmin': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, it makes the user of group_dn Grafana server admin.\nIf set to true, it makes the user of group_dn Grafana server admin.' } }, + withGrafanaAdmin(value=true): { + grafanaAdmin: value, + }, + '#withGroupDn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) LDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").\nLDAP distinguished name (DN) of LDAP group. If you want to match all (or no LDAP groups) then you can use wildcard ("*").' } }, + withGroupDn(value): { + groupDn: value, + }, + '#withOrgId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The Grafana organization database id.\nThe Grafana organization database id.' } }, + withOrgId(value): { + orgId: value, + }, + '#withOrgRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Assign users of group_dn the organization role Admin, Editor, or Viewer.\nAssign users of group_dn the organization role Admin, Editor, or Viewer.' } }, + withOrgRole(value): { + orgRole: value, + }, + }, + '#withGroupSearchBaseDns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.' } }, + withGroupSearchBaseDns(value): { + groupSearchBaseDns: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupSearchBaseDnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of the base DNs to search through for groups. Typically uses ou=groups.\nAn array of the base DNs to search through for groups. Typically uses ou=groups.' } }, + withGroupSearchBaseDnsMixin(value): { + groupSearchBaseDns+: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupSearchFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Group search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).\nGroup search filter, to retrieve the groups of which the user is a member (only set if memberOf attribute is not available).' } }, + withGroupSearchFilter(value): { + groupSearchFilter: value, + }, + '#withGroupSearchFilterUserAttribute': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The %s in the search filter will be replaced with the attribute defined in this field.\nThe %s in the search filter will be replaced with the attribute defined in this field.' } }, + withGroupSearchFilterUserAttribute(value): { + groupSearchFilterUserAttribute: value, + }, + '#withHost': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The LDAP server host.\nThe LDAP server host.' } }, + withHost(value): { + host: value, + }, + '#withMinTlsVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Minimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.\nMinimum TLS version allowed. Accepted values are: TLS1.2, TLS1.3.' } }, + withMinTlsVersion(value): { + minTlsVersion: value, + }, + '#withPort': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The LDAP server port.\nThe LDAP server port.' } }, + withPort(value): { + port: value, + }, + '#withRootCaCert': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The path to the root CA certificate.\nThe path to the root CA certificate.' } }, + withRootCaCert(value): { + rootCaCert: value, + }, + '#withRootCaCertValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.' } }, + withRootCaCertValue(value): { + rootCaCertValue: + (if std.isArray(value) + then value + else [value]), + }, + '#withRootCaCertValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) The Base64 encoded values of the root CA certificates.\nThe Base64 encoded values of the root CA certificates.' } }, + withRootCaCertValueMixin(value): { + rootCaCertValue+: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchBaseDns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.' } }, + withSearchBaseDns(value): { + searchBaseDns: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchBaseDnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) An array of base DNs to search through.\nAn array of base DNs to search through.' } }, + withSearchBaseDnsMixin(value): { + searchBaseDns+: + (if std.isArray(value) + then value + else [value]), + }, + '#withSearchFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".\nThe user search filter, for example "(cn=%s)" or "(sAMAccountName=%s)" or "(uid=%s)".' } }, + withSearchFilter(value): { + searchFilter: value, + }, + '#withSslSkipVerify': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, the SSL cert validation will be skipped.\nIf set to true, the SSL cert validation will be skipped.' } }, + withSslSkipVerify(value=true): { + sslSkipVerify: value, + }, + '#withStartTls': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If set to true, use LDAP with STARTTLS instead of LDAPS.\nIf set to true, use LDAP with STARTTLS instead of LDAPS.' } }, + withStartTls(value=true): { + startTls: value, + }, + '#withTimeout': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '(Number) The timeout in seconds for connecting to the LDAP host.\nThe timeout in seconds for connecting to the LDAP host.' } }, + withTimeout(value): { + timeout: value, + }, + '#withTlsCiphers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.' } }, + withTlsCiphers(value): { + tlsCiphers: + (if std.isArray(value) + then value + else [value]), + }, + '#withTlsCiphersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(List of String) Accepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.\nAccepted TLS ciphers. For a complete list of supported ciphers, refer to: https://go.dev/src/crypto/tls/cipher_suites.go.' } }, + withTlsCiphersMixin(value): { + tlsCiphers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withUseSsl': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Set to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).\nSet to true if LDAP server should use an encrypted TLS connection (either with STARTTLS or LDAPS).' } }, + withUseSsl(value=true): { + useSsl: value, + }, + }, + }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for LDAP. Defaults to `true`.' } }, + withEnabled(value=true): { + enabled: value, + }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from LDAP.' } }, + withSkipOrgRoleSync(value=true): { + skipOrgRoleSync: value, + }, + }, '#withOauth2Settings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '(Block Set, Max: 1) The OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers. (see below for nested schema)\nThe OAuth2 settings set. Required for github, gitlab, google, azuread, okta, generic_oauth providers.' } }, withOauth2Settings(value): { spec+: { @@ -514,7 +1176,7 @@ withAllowAssignGrafanaAdmin(value=true): { allowAssignGrafanaAdmin: value, }, - '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nIf not enabled, only existing Grafana users can log in using OAuth.' } }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nIf not enabled, only existing Grafana users can log in using OAuth.' } }, withAllowSignUp(value=true): { allowSignUp: value, }, @@ -607,7 +1269,7 @@ withEmptyScopes(value=true): { emptyScopes: value, }, - '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.' } }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for the specified provider. Defaults to `true`.' } }, withEnabled(value=true): { enabled: value, }, @@ -631,6 +1293,14 @@ withNameAttributePath(value): { nameAttributePath: value, }, + '#withOrgAttributePath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) JMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.\nJMESPath expression to use for the organization mapping lookup from the user ID token. The extracted list will be used for the organization mapping (to match "Organization" in the "org_mapping"). Only applicable to Generic OAuth and Okta.' } }, + withOrgAttributePath(value): { + orgAttributePath: value, + }, + '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.' } }, + withOrgMapping(value): { + orgMapping: value, + }, '#withRoleAttributePath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) JMESPath expression to use for Grafana role lookup.\nJMESPath expression to use for Grafana role lookup.' } }, withRoleAttributePath(value): { roleAttributePath: value, @@ -647,7 +1317,7 @@ withSignoutRedirectUrl(value): { signoutRedirectUrl: value, }, - '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, withSkipOrgRoleSync(value=true): { skipOrgRoleSync: value, }, @@ -692,7 +1362,7 @@ useRefreshToken: value, }, }, - '#withProviderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml.' } }, + '#withProviderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.\nThe name of the SSO provider. Supported values: github, gitlab, google, azuread, okta, generic_oauth, saml, ldap.' } }, withProviderName(value): { spec+: { parameters+: { @@ -735,7 +1405,7 @@ withAllowIdpInitiated(value=true): { allowIdpInitiated: value, }, - '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If not enabled, only existing Grafana users can log in using OAuth.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.' } }, + '#withAllowSignUp': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Whether to allow new Grafana user creation through LDAP login. If set to false, then only existing Grafana users can log in with LDAP.\nWhether to allow new Grafana user creation through SAML login. If set to false, then only existing Grafana users can log in with SAML.' } }, withAllowSignUp(value=true): { allowSignUp: value, }, @@ -804,10 +1474,22 @@ }, }, }, - '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for the specified provider. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.' } }, + '#withClientId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The client Id of your OAuth2 app.\nThe client Id of your OAuth2 app.' } }, + withClientId(value): { + clientId: value, + }, + '#withClientSecret': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String, Sensitive) The client secret of your OAuth2 app.\nThe client secret of your OAuth2 app.' } }, + withClientSecret(value): { + clientSecret: value, + }, + '#withEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Define whether this configuration is enabled for LDAP. Defaults to true.\nDefine whether this configuration is enabled for SAML. Defaults to `true`.' } }, withEnabled(value=true): { enabled: value, }, + '#withForceUseGraphApi': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) If enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.\nIf enabled, Grafana will fetch groups from Microsoft Graph API instead of using the groups claim from the ID token.' } }, + withForceUseGraphApi(value=true): { + forceUseGraphApi: value, + }, '#withIdpMetadata': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'encoded string for the IdP SAML metadata XML.\nBase64-encoded string for the IdP SAML metadata XML.' } }, withIdpMetadata(value): { idpMetadata: value, @@ -836,7 +1518,7 @@ withNameIdFormat(value): { nameIdFormat: value, }, - '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.' } }, + '#withOrgMapping': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'or space-separated Organization:OrgIdOrOrgName:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: None, Viewer, Editor or Admin.\nList of comma- or space-separated Organization:OrgId:Role mappings. Organization can be * meaning “All users”. Role is optional and can have the following values: Viewer, Editor or Admin.' } }, withOrgMapping(value): { orgMapping: value, }, @@ -905,10 +1587,14 @@ withSingleLogout(value=true): { singleLogout: value, }, - '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from your IdP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, + '#withSkipOrgRoleSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '(Boolean) Prevent synchronizing users’ organization roles from LDAP.\nPrevent synchronizing users’ organization roles from your IdP.' } }, withSkipOrgRoleSync(value=true): { skipOrgRoleSync: value, }, + '#withTokenUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The token endpoint of your OAuth2 provider. Required for azuread, okta and generic_oauth providers.\nThe token endpoint of your OAuth2 provider. Required for Azure AD providers.' } }, + withTokenUrl(value): { + tokenUrl: value, + }, }, }, '#withManagementPolicies': { 'function': { args: [{ default: ['*'], enums: null, name: 'value', type: ['array'] }], help: 'THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md' } }, diff --git a/grafanaplane/slo/v1alpha1/slo/spec/parameters.libsonnet b/grafanaplane/slo/v1alpha1/slo/spec/parameters.libsonnet index 07276a7..dc9b513 100644 --- a/grafanaplane/slo/v1alpha1/slo/spec/parameters.libsonnet +++ b/grafanaplane/slo/v1alpha1/slo/spec/parameters.libsonnet @@ -101,11 +101,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -144,11 +144,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -170,11 +170,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -197,11 +197,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -240,11 +240,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -266,11 +266,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -468,11 +468,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -621,6 +621,16 @@ type: value, }, }, + '#withSearchExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.' } }, + withSearchExpression(value): { + spec+: { + parameters+: { + forProvider+: { + searchExpression: value, + }, + }, + }, + }, }, '#withInitProvider': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.' } }, withInitProvider(value): { @@ -708,11 +718,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -751,11 +761,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -777,11 +787,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -804,11 +814,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -847,11 +857,11 @@ annotation+: { '#': { help: '', name: 'annotation' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -873,11 +883,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -1075,11 +1085,11 @@ label+: { '#': { help: '', name: 'label' }, - '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String)' } }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Key for filtering and identification\nKey for filtering and identification' } }, withKey(value): { key: value, }, - '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.' } }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value' } }, withValue(value): { value: value, }, @@ -1228,6 +1238,16 @@ type: value, }, }, + '#withSearchExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.' } }, + withSearchExpression(value): { + spec+: { + parameters+: { + initProvider+: { + searchExpression: value, + }, + }, + }, + }, }, '#withManagementPolicies': { 'function': { args: [{ default: ['*'], enums: null, name: 'value', type: ['array'] }], help: 'THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md' } }, withManagementPolicies(value): { diff --git a/grafanaplane/sm/v1alpha1/check/spec/parameters.libsonnet b/grafanaplane/sm/v1alpha1/check/spec/parameters.libsonnet index d4ef014..bdb856c 100644 --- a/grafanaplane/sm/v1alpha1/check/spec/parameters.libsonnet +++ b/grafanaplane/sm/v1alpha1/check/spec/parameters.libsonnet @@ -479,19 +479,69 @@ basicAuth+: { '#': { help: '', name: 'basicAuth' }, - '#withPassword': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Basic auth password.\nBasic auth password.' } }, - withPassword(value): { - password: value, + '#withPasswordSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Basic auth password.\nBasic auth password.' } }, + withPasswordSecretRef(value): { + passwordSecretRef: value, }, + '#withPasswordSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Basic auth password.\nBasic auth password.' } }, + withPasswordSecretRefMixin(value): { + passwordSecretRef+: value, + }, + passwordSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + passwordSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + passwordSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + passwordSecretRef+: { + namespace: value, + }, + }, + }, '#withUsername': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Basic auth username.\nBasic auth username.' } }, withUsername(value): { username: value, }, }, - '#withBearerToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, - withBearerToken(value): { - bearerToken: value, + '#withBearerTokenSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, + withBearerTokenSecretRef(value): { + bearerTokenSecretRef: value, }, + '#withBearerTokenSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, + withBearerTokenSecretRefMixin(value): { + bearerTokenSecretRef+: value, + }, + bearerTokenSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + bearerTokenSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + bearerTokenSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + bearerTokenSecretRef+: { + namespace: value, + }, + }, + }, '#withBody': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The body of the HTTP request used in probe.\nThe body of the HTTP request used in probe.' } }, withBody(value): { body: value, @@ -1643,19 +1693,69 @@ basicAuth+: { '#': { help: '', name: 'basicAuth' }, - '#withPassword': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Basic auth password.\nBasic auth password.' } }, - withPassword(value): { - password: value, + '#withPasswordSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Basic auth password.\nBasic auth password.' } }, + withPasswordSecretRef(value): { + passwordSecretRef: value, }, + '#withPasswordSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Basic auth password.\nBasic auth password.' } }, + withPasswordSecretRefMixin(value): { + passwordSecretRef+: value, + }, + passwordSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + passwordSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + passwordSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + passwordSecretRef+: { + namespace: value, + }, + }, + }, '#withUsername': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Basic auth username.\nBasic auth username.' } }, withUsername(value): { username: value, }, }, - '#withBearerToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, - withBearerToken(value): { - bearerToken: value, + '#withBearerTokenSecretRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, + withBearerTokenSecretRef(value): { + bearerTokenSecretRef: value, }, + '#withBearerTokenSecretRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '(String, Sensitive) Token for use with bearer authorization header.\nToken for use with bearer authorization header.' } }, + withBearerTokenSecretRefMixin(value): { + bearerTokenSecretRef+: value, + }, + bearerTokenSecretRef+: + { + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The key to select.' } }, + withKey(value): { + bearerTokenSecretRef+: { + key: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the secret.' } }, + withName(value): { + bearerTokenSecretRef+: { + name: value, + }, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Namespace of the secret.' } }, + withNamespace(value): { + bearerTokenSecretRef+: { + namespace: value, + }, + }, + }, '#withBody': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '(String) The body of the HTTP request used in probe.\nThe body of the HTTP request used in probe.' } }, withBody(value): { body: value, diff --git a/grafanaplane/version.libsonnet b/grafanaplane/version.libsonnet index 655142f..b883b7e 100644 --- a/grafanaplane/version.libsonnet +++ b/grafanaplane/version.libsonnet @@ -1 +1 @@ -'0.0.3-0.18.0' +'0.0.4-0.21.0'