From 738b40d6648459ae2fdd5327591a69fa1e568c6d Mon Sep 17 00:00:00 2001 From: Sasha Bauer Date: Tue, 31 Dec 2024 17:05:03 -0500 Subject: [PATCH] docs(oncall): build docs --- docs/README.md | 2 +- docs/oncall.md | 592 ----------- docs/oncall/index.md | 925 ++++++++++++++++++ docs/oncall/integration/defaultRoute/index.md | 334 +++++++ .../integration/defaultRoute/msteams.md | 36 + docs/oncall/integration/defaultRoute/slack.md | 36 + .../integration/defaultRoute/telegram.md | 36 + docs/oncall/integration/templates/email.md | 35 + docs/oncall/integration/templates/index.md | 280 ++++++ .../integration/templates/microsoftTeams.md | 48 + .../oncall/integration/templates/mobileApp.md | 35 + .../oncall/integration/templates/phoneCall.md | 22 + docs/oncall/integration/templates/slack.md | 48 + docs/oncall/integration/templates/sms.md | 22 + docs/oncall/integration/templates/telegram.md | 48 + docs/oncall/integration/templates/web.md | 48 + docs/oncall/schedule/shiftsRef.md | 82 ++ docs/oncall/schedule/slack.md | 35 + 18 files changed, 2071 insertions(+), 593 deletions(-) delete mode 100644 docs/oncall.md create mode 100644 docs/oncall/index.md create mode 100644 docs/oncall/integration/defaultRoute/index.md create mode 100644 docs/oncall/integration/defaultRoute/msteams.md create mode 100644 docs/oncall/integration/defaultRoute/slack.md create mode 100644 docs/oncall/integration/defaultRoute/telegram.md create mode 100644 docs/oncall/integration/templates/email.md create mode 100644 docs/oncall/integration/templates/index.md create mode 100644 docs/oncall/integration/templates/microsoftTeams.md create mode 100644 docs/oncall/integration/templates/mobileApp.md create mode 100644 docs/oncall/integration/templates/phoneCall.md create mode 100644 docs/oncall/integration/templates/slack.md create mode 100644 docs/oncall/integration/templates/sms.md create mode 100644 docs/oncall/integration/templates/telegram.md create mode 100644 docs/oncall/integration/templates/web.md create mode 100644 docs/oncall/schedule/shiftsRef.md create mode 100644 docs/oncall/schedule/slack.md diff --git a/docs/README.md b/docs/README.md index 4018c35..47c13f9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,7 +24,7 @@ local grafanaplane = import 'github.com/grafana/grafana-crossplane-libsonnet/gra ## Subpackages * [configurations](configurations.md) -* [oncall](oncall.md) +* [oncall](oncall/index.md) * [oss](oss/index.md) * [raw](raw/index.md) * [sm](sm/index.md) diff --git a/docs/oncall.md b/docs/oncall.md deleted file mode 100644 index 0c70c85..0000000 --- a/docs/oncall.md +++ /dev/null @@ -1,592 +0,0 @@ -# oncall - - - -## Index - -* [`obj escalation`](#obj-escalation) - * [`fn new(escalationChainName, position, type, providerName, resourceId="-")`](#fn-escalationnew) - * [`fn newNotifyOnCallFromSchedule(escalationChainName, position, scheduleName, providerName, resourceId="-")`](#fn-escalationnewnotifyoncallfromschedule) - * [`fn newNotifyPersons(escalationChainName, position, persons, providerName, resourceId="-")`](#fn-escalationnewnotifypersons) - * [`fn newWait(escalationChainName, position, duration, providerName, resourceId="-")`](#fn-escalationnewwait) -* [`obj escalationChain`](#obj-escalationchain) - * [`fn new(name, providerName, resourceId="rfc1123(name)")`](#fn-escalationchainnew) -* [`obj integration`](#obj-integration) - * [`fn new(name, type, providerName, resourceId="rfc1123(name)")`](#fn-integrationnew) - * [`fn withDefaultRoute(name)`](#fn-integrationwithdefaultroute) -* [`obj route`](#obj-route) - * [`fn new(id, integrationName, escalationChainName, providerName, routingRegex="null")`](#fn-routenew) -* [`obj schedule`](#obj-schedule) - * [`fn new(name, type, providerName, resourceId="rfc1123(name)")`](#fn-schedulenew) - * [`fn newCalendar(name, providerName, shiftNames="[]", resourceId="rfc1123(name)")`](#fn-schedulenewcalendar) -* [`obj shift`](#obj-shift) - * [`fn new(name, type, start, providerName, resourceId="rfc1123(name)")`](#fn-shiftnew) - * [`fn newRollingUsers(name, rollingUsers, start, duration, interval, providerName, byDay="null", byMonth="null", byMonthDay="null", resourceId="rfc1123(name)")`](#fn-shiftnewrollingusers) - * [`fn withByDay(value)`](#fn-shiftwithbyday) - * [`fn withByDayMixin(value)`](#fn-shiftwithbydaymixin) - * [`fn withByMonth(value)`](#fn-shiftwithbymonth) - * [`fn withByMonthMixin(value)`](#fn-shiftwithbymonthmixin) - * [`fn withByMonthday(value)`](#fn-shiftwithbymonthday) - * [`fn withByMonthdayMixin(value)`](#fn-shiftwithbymonthdaymixin) - * [`fn withDuration(value)`](#fn-shiftwithduration) - * [`fn withFrequency(value)`](#fn-shiftwithfrequency) - * [`fn withInterval(value)`](#fn-shiftwithinterval) - * [`fn withLevel(value)`](#fn-shiftwithlevel) - * [`fn withName(value)`](#fn-shiftwithname) - * [`fn withRollingUsers(value)`](#fn-shiftwithrollingusers) - * [`fn withRollingUsersMixin(value)`](#fn-shiftwithrollingusersmixin) - * [`fn withStart(value)`](#fn-shiftwithstart) - * [`fn withStartRotationFromUserIndex(value)`](#fn-shiftwithstartrotationfromuserindex) - * [`fn withTeamId(value)`](#fn-shiftwithteamid) - * [`fn withTimeZone(value)`](#fn-shiftwithtimezone) - * [`fn withType(value)`](#fn-shiftwithtype) - * [`fn withUntil(value)`](#fn-shiftwithuntil) - * [`fn withUsers(value)`](#fn-shiftwithusers) - * [`fn withUsersMixin(value)`](#fn-shiftwithusersmixin) - * [`fn withWeekStart(value)`](#fn-shiftwithweekstart) - -## Fields - -### obj escalation - - -#### fn escalation.new - -```jsonnet -escalation.new(escalationChainName, position, type, providerName, resourceId="-") -``` - -PARAMETERS: - -* **escalationChainName** (`string`) -* **position** (`number`) -* **type** (`string`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"-"` - -`new` creates an Escalation. `escalationChainName` is the resource name -(`myescalationchain.metadata.name`) of the parent Escalation Chain. -`position` is the position of the Escalation in the chain. `type` is the -Escalation type. `providerName` is the resource name -(`myprovider.metadata.name`) of the Provider. `resourceId` defaults to -`-`. - -#### fn escalation.newNotifyOnCallFromSchedule - -```jsonnet -escalation.newNotifyOnCallFromSchedule(escalationChainName, position, scheduleName, providerName, resourceId="-") -``` - -PARAMETERS: - -* **escalationChainName** (`string`) -* **position** (`number`) -* **scheduleName** (`string`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"-"` - -`newNotifyOnCallFromSchedule` creates an Escalation of type -`noitfy_on_call_from_schedule`. `escalationChainName` is the resource -name (`myescalationchain.metadata.name`) of the parent Escalation Chain. -`position` is the position of the Escalation in the chain. `scheduleName` -is the resource name of the Schedule to reference. `providerName` is the -resource name (`myprovider.metadata.name`) of the Provider. `resourceId` -defaults to `-`. - -#### fn escalation.newNotifyPersons - -```jsonnet -escalation.newNotifyPersons(escalationChainName, position, persons, providerName, resourceId="-") -``` - -PARAMETERS: - -* **escalationChainName** (`string`) -* **position** (`number`) -* **persons** (`array`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"-"` - -`newNotifyPersons` creates an Escalation of type `noitfy_persons`. -`escalationChainName` is the resource name -(`myescalationchain.metadata.name`) of the parent Escalation Chain. -`position` is the position of the Escalation in the chain. `persons` is -the array of persons (by email address) to notify. `providerName` is the -resource name (`myprovider.metadata.name`) of the Provider. `resourceId` -defaults to `-`. - -#### fn escalation.newWait - -```jsonnet -escalation.newWait(escalationChainName, position, duration, providerName, resourceId="-") -``` - -PARAMETERS: - -* **escalationChainName** (`string`) -* **position** (`number`) -* **duration** (`number`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"-"` - -`newWait` creates an Escalation of type `wait`. `escalationChainName` is -the resource name (`myescalationchain.metadata.name`) of the parent -Escalation Chain. `position` is the position of the Escalation in the -chain. `duration` is the duration in seconds to wait. `providerName` is -the resource name (`myprovider.metadata.name`) of the Provider. -`resourceId` defaults to `-`. - -### obj escalationChain - - -#### fn escalationChain.new - -```jsonnet -escalationChain.new(name, providerName, resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`new` creates an Escalation Chain. The `name` is a display-friendly -string, and `resourceId` defaults to a slug-ified version of it. -`providerName` is the resource name (`myprovider.metadata.name`) of -the Provider. - -### obj integration - - -#### fn integration.new - -```jsonnet -integration.new(name, type, providerName, resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **type** (`string`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`new` creates an Integration. The `name` is a display-friendly -string, and `resourceId` defaults to a slug-ified version of it. -`type` is the type of Integration. `providerName` is the resource -name (`myprovider.metadata.name`) of the Provider. - -#### fn integration.withDefaultRoute - -```jsonnet -integration.withDefaultRoute(name) -``` - -PARAMETERS: - -* **name** (`string`) - -`withDefaultRoute` configures the default route using an Escalation -Chain object's name. - -### obj route - - -#### fn route.new - -```jsonnet -route.new(id, integrationName, escalationChainName, providerName, routingRegex="null") -``` - -PARAMETERS: - -* **id** (`string`) -* **integrationName** (`string`) -* **escalationChainName** (`string`) -* **providerName** (`string`) -* **routingRegex** (`string`) - - default value: `"null"` - -`new` creates a Route. `id` is the resource name. `integrationName` -is the resource name of the Integration to reference. -`escalationChainName` is the resource name of the Escalation Chain to -reference. `routingRegex` is configured as a routing regex, if -supplied. `providerName` is the resource name -(`myprovider.metadata.name`) of the Provider. - -### obj schedule - - -#### fn schedule.new - -```jsonnet -schedule.new(name, type, providerName, resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **type** (`string`) - - valid values: `"ical"`, `"calendar"` -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`new` creates a Schedule. The `name` is a display-friendly -string, and `resourceId` defaults to a slug-ified version of it. -`type` is the type of Schedule. `providerName` is the resource -name (`myprovider.metadata.name`) of the Provider. - -#### fn schedule.newCalendar - -```jsonnet -schedule.newCalendar(name, providerName, shiftNames="[]", resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **providerName** (`string`) -* **shiftNames** (`array`) - - default value: `"[]"` -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`newCalendar` creates a Schedule with type `calendar`. The `name` is a -display-friendly string, and `resourceId` defaults to a slug-ified -version of it. `providerName` is the resource name -(`myprovider.metadata.name`) of the Provider. If supplied, `shiftNames` -are supplied to `withShiftsRef` to associate an array of shifts by -resource name. - -### obj shift - - -#### fn shift.new - -```jsonnet -shift.new(name, type, start, providerName, resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **type** (`string`) -* **start** (`string`) -* **providerName** (`string`) -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`new` creates an OnCallShift. The `name` is a display-friendly string, -and `resourceId` defaults to a slug-ified version of it. `type` is the -type of Shift. `start` is the start time of the shift in -`yyyy-MM-dd'T'HH:mm:ss` format. `providerName` is the resource name -(`myprovider.metadata.name`) of the Provider. - -#### fn shift.newRollingUsers - -```jsonnet -shift.newRollingUsers(name, rollingUsers, start, duration, interval, providerName, byDay="null", byMonth="null", byMonthDay="null", resourceId="rfc1123(name)") -``` - -PARAMETERS: - -* **name** (`string`) -* **rollingUsers** (`array`) -* **start** (`string`) -* **duration** (`number`) -* **interval** (`number`) -* **providerName** (`string`) -* **byDay** (`array`) - - default value: `"null"` -* **byMonth** (`array`) - - default value: `"null"` -* **byMonthDay** (`array`) - - default value: `"null"` -* **resourceId** (`string`) - - default value: `"rfc1123(name)"` - -`newRollingUsers` creates an OnCallShift of `rolling_users` type. The -`name` is a display-friendly string, and `resourceId` defaults to a -slug-ified version of it. `rollingUsers` is the list of users as an array -of strings. `start` is the start time of the shift in -`yyyy-MM-dd'T'HH:mm:ss` format. `duration` is the length of each shift in -seconds. `interval` is the interval at which the recurrence rule repeats. -`providerName` is the resource name (`myprovider.metadata.name`) of the -Provider. `byDay` is a list of days in iCal format on which the shift -takes place. `byMonth` is a list of months in which the shift takes -place. `byMonthDay` is a list of month days on which the shift takes -place. If any of `byDay`, `byMonth`, or `byMonthDay` is `null` (default), -it is omitted. - -#### fn shift.withByDay - -```jsonnet -shift.withByDay(value) -``` - -PARAMETERS: - -* **value** (`array`) - -(Set of String) This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU -This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU -#### fn shift.withByDayMixin - -```jsonnet -shift.withByDayMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -(Set of String) This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU -This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU -#### fn shift.withByMonth - -```jsonnet -shift.withByMonth(value) -``` - -PARAMETERS: - -* **value** (`array`) - -(Set of Number) This parameter takes a list of months. Valid values are 1 to 12 -This parameter takes a list of months. Valid values are 1 to 12 -#### fn shift.withByMonthMixin - -```jsonnet -shift.withByMonthMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -(Set of Number) This parameter takes a list of months. Valid values are 1 to 12 -This parameter takes a list of months. Valid values are 1 to 12 -#### fn shift.withByMonthday - -```jsonnet -shift.withByMonthday(value) -``` - -PARAMETERS: - -* **value** (`array`) - -31 to -1 -This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1 -#### fn shift.withByMonthdayMixin - -```jsonnet -shift.withByMonthdayMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -31 to -1 -This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1 -#### fn shift.withDuration - -```jsonnet -shift.withDuration(value) -``` - -PARAMETERS: - -* **value** (`number`) - -(Number) The duration of the event. -The duration of the event. -#### fn shift.withFrequency - -```jsonnet -shift.withFrequency(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(String) The frequency of the event. Can be hourly, daily, weekly, monthly -The frequency of the event. Can be hourly, daily, weekly, monthly -#### fn shift.withInterval - -```jsonnet -shift.withInterval(value) -``` - -PARAMETERS: - -* **value** (`number`) - -(Number) The positive integer representing at which intervals the recurrence rule repeats. -The positive integer representing at which intervals the recurrence rule repeats. -#### fn shift.withLevel - -```jsonnet -shift.withLevel(value) -``` - -PARAMETERS: - -* **value** (`number`) - -(Number) The priority level. The higher the value, the higher the priority. -The priority level. The higher the value, the higher the priority. -#### fn shift.withName - -```jsonnet -shift.withName(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(String) The shift's name. -The shift's name. -#### fn shift.withRollingUsers - -```jsonnet -shift.withRollingUsers(value) -``` - -PARAMETERS: - -* **value** (`array`) - -call users (for rolling_users event type) -The list of lists with on-call users (for rolling_users event type) -#### fn shift.withRollingUsersMixin - -```jsonnet -shift.withRollingUsersMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -call users (for rolling_users event type) -The list of lists with on-call users (for rolling_users event type) -#### fn shift.withStart - -```jsonnet -shift.withStart(value) -``` - -PARAMETERS: - -* **value** (`string`) - -call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") -The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") -#### fn shift.withStartRotationFromUserIndex - -```jsonnet -shift.withStartRotationFromUserIndex(value) -``` - -PARAMETERS: - -* **value** (`number`) - -call rotation starts. -The index of the list of users in rolling_users, from which on-call rotation starts. -#### fn shift.withTeamId - -```jsonnet -shift.withTeamId(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana_oncall_team datasource. -The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource. -#### fn shift.withTimeZone - -```jsonnet -shift.withTimeZone(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(String) The shift's timezone. Overrides schedule's timezone. -The shift's timezone. Overrides schedule's timezone. -#### fn shift.withType - -```jsonnet -shift.withType(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(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 shift.withUntil - -```jsonnet -shift.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 shift.withUsers - -```jsonnet -shift.withUsers(value) -``` - -PARAMETERS: - -* **value** (`array`) - -call users (for single_event and recurrent_event event type). -The list of on-call users (for single_event and recurrent_event event type). -#### fn shift.withUsersMixin - -```jsonnet -shift.withUsersMixin(value) -``` - -PARAMETERS: - -* **value** (`array`) - -call users (for single_event and recurrent_event event type). -The list of on-call users (for single_event and recurrent_event event type). -#### fn shift.withWeekStart - -```jsonnet -shift.withWeekStart(value) -``` - -PARAMETERS: - -* **value** (`string`) - -(String) Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU -Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU \ No newline at end of file diff --git a/docs/oncall/index.md b/docs/oncall/index.md new file mode 100644 index 0000000..da5fd5b --- /dev/null +++ b/docs/oncall/index.md @@ -0,0 +1,925 @@ +# oncall + + + +## Subpackages + +* [integration.defaultRoute](integration/defaultRoute/index.md) +* [integration.templates](integration/templates/index.md) +* [schedule.shiftsRef](schedule/shiftsRef.md) +* [schedule.slack](schedule/slack.md) + +## Index + +* [`obj escalationChain`](#obj-escalationchain) + * [`fn new(name, id="rfc1123(name)")`](#fn-escalationchainnew) + * [`fn withName(value)`](#fn-escalationchainwithname) + * [`fn withSteps()`](#fn-escalationchainwithsteps) + * [`fn withTeamId(value)`](#fn-escalationchainwithteamid) + * [`obj step`](#obj-escalationchainstep) + * [`fn notifyOnCallFromSchedule(schedule)`](#fn-escalationchainstepnotifyoncallfromschedule) + * [`fn notifyPersons(persons)`](#fn-escalationchainstepnotifypersons) + * [`fn wait(seconds)`](#fn-escalationchainstepwait) +* [`obj integration`](#obj-integration) + * [`fn new(name, type, id="rfc1123(name)")`](#fn-integrationnew) + * [`fn withDefaultChain(escalationChain)`](#fn-integrationwithdefaultchain) + * [`fn withDefaultRoute(value)`](#fn-integrationwithdefaultroute) + * [`fn withDefaultRouteMixin(value)`](#fn-integrationwithdefaultroutemixin) + * [`fn withName(value)`](#fn-integrationwithname) + * [`fn withRoutes(routes)`](#fn-integrationwithroutes) + * [`fn withTeamId(value)`](#fn-integrationwithteamid) + * [`fn withTemplates(value)`](#fn-integrationwithtemplates) + * [`fn withTemplatesMixin(value)`](#fn-integrationwithtemplatesmixin) + * [`fn withType(value)`](#fn-integrationwithtype) + * [`obj route`](#obj-integrationroute) + * [`fn chain(name)`](#fn-integrationroutechain) + * [`fn withRoutingRegex(regex)`](#fn-integrationroutewithroutingregex) +* [`obj schedule`](#obj-schedule) + * [`fn new(name, type, providerName, resourceId="rfc1123(name)")`](#fn-schedulenew) + * [`fn withEnableWebOverrides(value=true)`](#fn-schedulewithenableweboverrides) + * [`fn withIcalUrlOverrides(value)`](#fn-schedulewithicalurloverrides) + * [`fn withIcalUrlPrimary(value)`](#fn-schedulewithicalurlprimary) + * [`fn withName(value)`](#fn-schedulewithname) + * [`fn withShifts(shifts="null")`](#fn-schedulewithshifts) + * [`fn withShiftsMixin(value)`](#fn-schedulewithshiftsmixin) + * [`fn withShiftsRef(value)`](#fn-schedulewithshiftsref) + * [`fn withShiftsRefMixin(value)`](#fn-schedulewithshiftsrefmixin) + * [`fn withShiftsSelector(value)`](#fn-schedulewithshiftsselector) + * [`fn withShiftsSelectorMixin(value)`](#fn-schedulewithshiftsselectormixin) + * [`fn withSlack(value)`](#fn-schedulewithslack) + * [`fn withSlackMixin(value)`](#fn-schedulewithslackmixin) + * [`fn withTeamId(value)`](#fn-schedulewithteamid) + * [`fn withTimeZone(value)`](#fn-schedulewithtimezone) + * [`fn withType(value)`](#fn-schedulewithtype) + * [`obj shiftsSelector`](#obj-scheduleshiftsselector) + * [`fn withMatchControllerRef(value=true)`](#fn-scheduleshiftsselectorwithmatchcontrollerref) + * [`fn withMatchLabels(value)`](#fn-scheduleshiftsselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(value)`](#fn-scheduleshiftsselectorwithmatchlabelsmixin) + * [`fn withPolicy(value)`](#fn-scheduleshiftsselectorwithpolicy) + * [`fn withPolicyMixin(value)`](#fn-scheduleshiftsselectorwithpolicymixin) + * [`obj policy`](#obj-scheduleshiftsselectorpolicy) + * [`fn withResolution(value="Required")`](#fn-scheduleshiftsselectorpolicywithresolution) + * [`fn withResolve(value)`](#fn-scheduleshiftsselectorpolicywithresolve) +* [`obj shift`](#obj-shift) + * [`fn new(name, resourceId="rfc1123(name)")`](#fn-shiftnew) + * [`fn withByDay(value)`](#fn-shiftwithbyday) + * [`fn withByDayMixin(value)`](#fn-shiftwithbydaymixin) + * [`fn withByMonth(value)`](#fn-shiftwithbymonth) + * [`fn withByMonthMixin(value)`](#fn-shiftwithbymonthmixin) + * [`fn withByMonthday(value)`](#fn-shiftwithbymonthday) + * [`fn withByMonthdayMixin(value)`](#fn-shiftwithbymonthdaymixin) + * [`fn withDuration(value)`](#fn-shiftwithduration) + * [`fn withFrequency(value)`](#fn-shiftwithfrequency) + * [`fn withInterval(value)`](#fn-shiftwithinterval) + * [`fn withLevel(value)`](#fn-shiftwithlevel) + * [`fn withName(value)`](#fn-shiftwithname) + * [`fn withRollingUsers(frequency, users)`](#fn-shiftwithrollingusers) + * [`fn withRollingUsersMixin(value)`](#fn-shiftwithrollingusersmixin) + * [`fn withStart(value)`](#fn-shiftwithstart) + * [`fn withStartRotationFromUserIndex(value)`](#fn-shiftwithstartrotationfromuserindex) + * [`fn withTeamId(value)`](#fn-shiftwithteamid) + * [`fn withTimeZone(value)`](#fn-shiftwithtimezone) + * [`fn withType(value)`](#fn-shiftwithtype) + * [`fn withUntil(value)`](#fn-shiftwithuntil) + * [`fn withUsers(value)`](#fn-shiftwithusers) + * [`fn withUsersMixin(value)`](#fn-shiftwithusersmixin) + * [`fn withWeekStart(value)`](#fn-shiftwithweekstart) + +## Fields + +### obj escalationChain + + +#### fn escalationChain.new + +```jsonnet +escalationChain.new(name, id="rfc1123(name)") +``` + +PARAMETERS: + +* **name** (`string`) +* **id** (`string`) + - default value: `"rfc1123(name)"` + +`new` creates an Escalation Chain. The `name` is a display-friendly +string, and `id` defaults to a slug-ified version of it. + +#### fn escalationChain.withName + +```jsonnet +escalationChain.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The name of the escalation chain. +The name of the escalation chain. +#### fn escalationChain.withSteps + +```jsonnet +escalationChain.withSteps() +``` + + +`withSteps` configures one or more Escalation resources as steps within +the calling Escalation Chain. + +#### fn escalationChain.withTeamId + +```jsonnet +escalationChain.withTeamId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana_oncall_team datasource. +The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource. +#### obj escalationChain.step + + +##### fn escalationChain.step.notifyOnCallFromSchedule + +```jsonnet +escalationChain.step.notifyOnCallFromSchedule(schedule) +``` + +PARAMETERS: + +* **schedule** (`string|object`) + +`notifyOnCallFromSchedule` configures an Escalation step to notify +on-call persons from the given Schedule. `schedule` may be either a +Schedule resource name or a manifest. + +##### fn escalationChain.step.notifyPersons + +```jsonnet +escalationChain.step.notifyPersons(persons) +``` + +PARAMETERS: + +* **persons** (`array`) + +`notifyPersons` configures an Escalation step to notify a list of +persons. + +##### fn escalationChain.step.wait + +```jsonnet +escalationChain.step.wait(seconds) +``` + +PARAMETERS: + +* **seconds** (`number`) + +`wait` configures an Escalation step to wait for acknowledgement for +the given number of seconds before proceeding. + +### obj integration + + +#### fn integration.new + +```jsonnet +integration.new(name, type, id="rfc1123(name)") +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **id** (`string`) + - default value: `"rfc1123(name)"` + +`new` creates an Integration. The `name` is a display-friendly string, +and `id` defaults to a slug-ified version of it. `type` is the type of +Integration. + +#### fn integration.withDefaultChain + +```jsonnet +integration.withDefaultChain(escalationChain) +``` + +PARAMETERS: + +* **escalationChain** (`string`) + +`withDefaulChain` configures the default route of an Integration to use +an Escalation Chain. `escalationChain` is the resource name or manifest +of the desired Escalation Chain. + +#### fn integration.withDefaultRoute + +```jsonnet +integration.withDefaultRoute(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The Default route for all alerts from the given integration (see below for nested schema) +The Default route for all alerts from the given integration +#### fn integration.withDefaultRouteMixin + +```jsonnet +integration.withDefaultRouteMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Min: 1, Max: 1) The Default route for all alerts from the given integration (see below for nested schema) +The Default route for all alerts from the given integration +#### fn integration.withName + +```jsonnet +integration.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The name of the service integration. +The name of the service integration. +#### fn integration.withRoutes + +```jsonnet +integration.withRoutes(routes) +``` + +PARAMETERS: + +* **routes** (`object`) + +`withRoute` configures Route resources connecting this Integration with +Escalation Chains. + +#### fn integration.withTeamId + +```jsonnet +integration.withTeamId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana_oncall_team datasource. +The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource. +#### fn integration.withTemplates + +```jsonnet +integration.withTemplates(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Jinja2 templates for Alert payload. An empty templates block will be ignored. (see below for nested schema) +Jinja2 templates for Alert payload. An empty templates block will be ignored. +#### fn integration.withTemplatesMixin + +```jsonnet +integration.withTemplatesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Jinja2 templates for Alert payload. An empty templates block will be ignored. (see below for nested schema) +Jinja2 templates for Alert payload. An empty templates block will be ignored. +#### fn integration.withType + +```jsonnet +integration.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The type of integration. Can be grafana, grafana_alerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazon_sns, curler, sentry, formatted_webhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentry_platform, zabbix, prtg, slack_channel, inbound_email, direct_paging, jira. +The type of integration. Can be grafana, grafana_alerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazon_sns, curler, sentry, formatted_webhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentry_platform, zabbix, prtg, slack_channel, inbound_email, direct_paging, jira. +#### obj integration.route + + +##### fn integration.route.chain + +```jsonnet +integration.route.chain(name) +``` + +PARAMETERS: + +* **name** (`string`) + +`chain` configures a Route to reference an Escalation Chain. + +##### fn integration.route.withRoutingRegex + +```jsonnet +integration.route.withRoutingRegex(regex) +``` + +PARAMETERS: + +* **regex** (`string`) + +`withRoutingRegex` configures a Route to have routing type `regex` and +use the supplied regex. + +### obj schedule + + +#### fn schedule.new + +```jsonnet +schedule.new(name, type, providerName, resourceId="rfc1123(name)") +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) + - valid values: `"ical"`, `"calendar"` +* **providerName** (`string`) +* **resourceId** (`string`) + - default value: `"rfc1123(name)"` + +`new` creates a Schedule. The `name` is a display-friendly +string, and `id` defaults to a slug-ified version of it. + +#### fn schedule.withEnableWebOverrides + +```jsonnet +schedule.withEnableWebOverrides(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Enable overrides via web UI (it will ignore ical_url_overrides). +Enable overrides via web UI (it will ignore ical_url_overrides). +#### fn schedule.withIcalUrlOverrides + +```jsonnet +schedule.withIcalUrlOverrides(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The URL of external iCal calendar which override primary events. +The URL of external iCal calendar which override primary events. +#### fn schedule.withIcalUrlPrimary + +```jsonnet +schedule.withIcalUrlPrimary(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The URL of the external calendar iCal file. +The URL of the external calendar iCal file. +#### fn schedule.withName + +```jsonnet +schedule.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The schedule's name. +The schedule's name. +#### fn schedule.withShifts + +```jsonnet +schedule.withShifts(shifts="null") +``` + +PARAMETERS: + +* **shifts** (`array`) + - default value: `"null"` + +`withShifts` sets a Schedule to type `calendar` and configures shifts. +Shifts are only applicable to `calendar` type Schedules. `shifts` is an +array of Shift resource names or entire Shift manifests. + +#### fn schedule.withShiftsMixin + +```jsonnet +schedule.withShiftsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +call shifts. +The list of ID's of on-call shifts. +#### fn schedule.withShiftsRef + +```jsonnet +schedule.withShiftsRef(value) +``` + +PARAMETERS: + +* **value** (`array`) + +References to OnCallShift in oncall to populate shifts. +#### fn schedule.withShiftsRefMixin + +```jsonnet +schedule.withShiftsRefMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +References to OnCallShift in oncall to populate shifts. +#### fn schedule.withShiftsSelector + +```jsonnet +schedule.withShiftsSelector(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Selector for a list of OnCallShift in oncall to populate shifts. +#### fn schedule.withShiftsSelectorMixin + +```jsonnet +schedule.withShiftsSelectorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Selector for a list of OnCallShift in oncall to populate shifts. +#### fn schedule.withSlack + +```jsonnet +schedule.withSlack(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a schedule. (see below for nested schema) +The Slack-specific settings for a schedule. +#### fn schedule.withSlackMixin + +```jsonnet +schedule.withSlackMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a schedule. (see below for nested schema) +The Slack-specific settings for a schedule. +#### fn schedule.withTeamId + +```jsonnet +schedule.withTeamId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana_oncall_team datasource. +The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource. +#### fn schedule.withTimeZone + +```jsonnet +schedule.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The schedule's time zone. +The schedule's time zone. +#### fn schedule.withType + +```jsonnet +schedule.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The schedule's type. Valid values are ical, calendar. +The schedule's type. Valid values are `ical`, `calendar`. +#### obj schedule.shiftsSelector + + +##### fn schedule.shiftsSelector.withMatchControllerRef + +```jsonnet +schedule.shiftsSelector.withMatchControllerRef(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +MatchControllerRef ensures an object with the same controller reference +as the selecting object is selected. +##### fn schedule.shiftsSelector.withMatchLabels + +```jsonnet +schedule.shiftsSelector.withMatchLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + +MatchLabels ensures an object with matching labels is selected. +##### fn schedule.shiftsSelector.withMatchLabelsMixin + +```jsonnet +schedule.shiftsSelector.withMatchLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +MatchLabels ensures an object with matching labels is selected. +##### fn schedule.shiftsSelector.withPolicy + +```jsonnet +schedule.shiftsSelector.withPolicy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for selection. +##### fn schedule.shiftsSelector.withPolicyMixin + +```jsonnet +schedule.shiftsSelector.withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for selection. +##### obj schedule.shiftsSelector.policy + + +###### fn schedule.shiftsSelector.policy.withResolution + +```jsonnet +schedule.shiftsSelector.policy.withResolution(value="Required") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Required"` + - valid values: `"Required"`, `"Optional"` + +Resolution specifies whether resolution of this reference is required. +The default is 'Required', which means the reconcile will fail if the +reference cannot be resolved. 'Optional' means this reference will be +a no-op if it cannot be resolved. +###### fn schedule.shiftsSelector.policy.withResolve + +```jsonnet +schedule.shiftsSelector.policy.withResolve(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Always"`, `"IfNotPresent"` + +Resolve specifies when this reference should be resolved. The default +is 'IfNotPresent', which will attempt to resolve the reference only when +the corresponding field is not present. Use 'Always' to resolve the +reference on every reconcile. +### obj shift + + +#### fn shift.new + +```jsonnet +shift.new(name, resourceId="rfc1123(name)") +``` + +PARAMETERS: + +* **name** (`string`) +* **resourceId** (`string`) + - default value: `"rfc1123(name)"` + +`new` creates an OnCallShift. The `name` is a display-friendly string, +and `id` defaults to a slug-ified version of it. + +#### fn shift.withByDay + +```jsonnet +shift.withByDay(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Set of String) This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU +This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU +#### fn shift.withByDayMixin + +```jsonnet +shift.withByDayMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Set of String) This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU +This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU +#### fn shift.withByMonth + +```jsonnet +shift.withByMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Set of Number) This parameter takes a list of months. Valid values are 1 to 12 +This parameter takes a list of months. Valid values are 1 to 12 +#### fn shift.withByMonthMixin + +```jsonnet +shift.withByMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Set of Number) This parameter takes a list of months. Valid values are 1 to 12 +This parameter takes a list of months. Valid values are 1 to 12 +#### fn shift.withByMonthday + +```jsonnet +shift.withByMonthday(value) +``` + +PARAMETERS: + +* **value** (`array`) + +31 to -1 +This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1 +#### fn shift.withByMonthdayMixin + +```jsonnet +shift.withByMonthdayMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +31 to -1 +This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1 +#### fn shift.withDuration + +```jsonnet +shift.withDuration(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The duration of the event. +The duration of the event. +#### fn shift.withFrequency + +```jsonnet +shift.withFrequency(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The frequency of the event. Can be hourly, daily, weekly, monthly +The frequency of the event. Can be hourly, daily, weekly, monthly +#### fn shift.withInterval + +```jsonnet +shift.withInterval(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The positive integer representing at which intervals the recurrence rule repeats. +The positive integer representing at which intervals the recurrence rule repeats. +#### fn shift.withLevel + +```jsonnet +shift.withLevel(value) +``` + +PARAMETERS: + +* **value** (`number`) + +(Number) The priority level. The higher the value, the higher the priority. +The priority level. The higher the value, the higher the priority. +#### fn shift.withName + +```jsonnet +shift.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The shift's name. +The shift's name. +#### fn shift.withRollingUsers + +```jsonnet +shift.withRollingUsers(frequency, users) +``` + +PARAMETERS: + +* **frequency** (`string`) + - valid values: `"hourly"`, `"daily"`, `"weekly"`, `"monthly"` +* **users** (`array`) + +`withRollingUsers` sets an OnCallShift to type `rolling_users` and +configures required fields. `users` must be an array *of arrays* +of strings referring to users by email address. `frequency` is required +for this shift type. + +#### fn shift.withRollingUsersMixin + +```jsonnet +shift.withRollingUsersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +call users (for rolling_users event type) +The list of lists with on-call users (for rolling_users event type) +#### fn shift.withStart + +```jsonnet +shift.withStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") +The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00") +#### fn shift.withStartRotationFromUserIndex + +```jsonnet +shift.withStartRotationFromUserIndex(value) +``` + +PARAMETERS: + +* **value** (`number`) + +call rotation starts. +The index of the list of users in rolling_users, from which on-call rotation starts. +#### fn shift.withTeamId + +```jsonnet +shift.withTeamId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana_oncall_team datasource. +The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana_oncall_team` datasource. +#### fn shift.withTimeZone + +```jsonnet +shift.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The shift's timezone. Overrides schedule's timezone. +The shift's timezone. Overrides schedule's timezone. +#### fn shift.withType + +```jsonnet +shift.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(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 shift.withUntil + +```jsonnet +shift.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 shift.withUsers + +```jsonnet +shift.withUsers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +call users (for single_event and recurrent_event event type). +The list of on-call users (for single_event and recurrent_event event type). +#### fn shift.withUsersMixin + +```jsonnet +shift.withUsersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +call users (for single_event and recurrent_event event type). +The list of on-call users (for single_event and recurrent_event event type). +#### fn shift.withWeekStart + +```jsonnet +shift.withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU +Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU \ No newline at end of file diff --git a/docs/oncall/integration/defaultRoute/index.md b/docs/oncall/integration/defaultRoute/index.md new file mode 100644 index 0000000..c7411f9 --- /dev/null +++ b/docs/oncall/integration/defaultRoute/index.md @@ -0,0 +1,334 @@ +# defaultRoute + + + +## Subpackages + +* [msteams](msteams.md) +* [slack](slack.md) +* [telegram](telegram.md) + +## Index + +* [`fn withEscalationChainId(value)`](#fn-withescalationchainid) +* [`fn withEscalationChainRef(value)`](#fn-withescalationchainref) +* [`fn withEscalationChainRefMixin(value)`](#fn-withescalationchainrefmixin) +* [`fn withEscalationChainSelector(value)`](#fn-withescalationchainselector) +* [`fn withEscalationChainSelectorMixin(value)`](#fn-withescalationchainselectormixin) +* [`fn withMsteams(value)`](#fn-withmsteams) +* [`fn withMsteamsMixin(value)`](#fn-withmsteamsmixin) +* [`fn withSlack(value)`](#fn-withslack) +* [`fn withSlackMixin(value)`](#fn-withslackmixin) +* [`fn withTelegram(value)`](#fn-withtelegram) +* [`fn withTelegramMixin(value)`](#fn-withtelegrammixin) +* [`obj escalationChainRef`](#obj-escalationchainref) + * [`fn withName(value)`](#fn-escalationchainrefwithname) + * [`fn withPolicy(value)`](#fn-escalationchainrefwithpolicy) + * [`fn withPolicyMixin(value)`](#fn-escalationchainrefwithpolicymixin) + * [`obj policy`](#obj-escalationchainrefpolicy) + * [`fn withResolution(value="Required")`](#fn-escalationchainrefpolicywithresolution) + * [`fn withResolve(value)`](#fn-escalationchainrefpolicywithresolve) +* [`obj escalationChainSelector`](#obj-escalationchainselector) + * [`fn withMatchControllerRef(value=true)`](#fn-escalationchainselectorwithmatchcontrollerref) + * [`fn withMatchLabels(value)`](#fn-escalationchainselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(value)`](#fn-escalationchainselectorwithmatchlabelsmixin) + * [`fn withPolicy(value)`](#fn-escalationchainselectorwithpolicy) + * [`fn withPolicyMixin(value)`](#fn-escalationchainselectorwithpolicymixin) + * [`obj policy`](#obj-escalationchainselectorpolicy) + * [`fn withResolution(value="Required")`](#fn-escalationchainselectorpolicywithresolution) + * [`fn withResolve(value)`](#fn-escalationchainselectorpolicywithresolve) + +## Fields + +### fn withEscalationChainId + +```jsonnet +withEscalationChainId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of the escalation chain. +The ID of the escalation chain. +### fn withEscalationChainRef + +```jsonnet +withEscalationChainRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reference to a EscalationChain in oncall to populate escalationChainId. +### fn withEscalationChainRefMixin + +```jsonnet +withEscalationChainRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reference to a EscalationChain in oncall to populate escalationChainId. +### fn withEscalationChainSelector + +```jsonnet +withEscalationChainSelector(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Selector for a EscalationChain in oncall to populate escalationChainId. +### fn withEscalationChainSelectorMixin + +```jsonnet +withEscalationChainSelectorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Selector for a EscalationChain in oncall to populate escalationChainId. +### fn withMsteams + +```jsonnet +withMsteams(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +MS teams-specific settings for a route. +### fn withMsteamsMixin + +```jsonnet +withMsteamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +MS teams-specific settings for a route. +### fn withSlack + +```jsonnet +withSlack(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Slack-specific settings for a route. +### fn withSlackMixin + +```jsonnet +withSlackMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Slack-specific settings for a route. +### fn withTelegram + +```jsonnet +withTelegram(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Telegram-specific settings for a route. +### fn withTelegramMixin + +```jsonnet +withTelegramMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Telegram-specific settings for a route. +### obj escalationChainRef + + +#### fn escalationChainRef.withName + +```jsonnet +escalationChainRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the referenced object. +#### fn escalationChainRef.withPolicy + +```jsonnet +escalationChainRef.withPolicy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for referencing. +#### fn escalationChainRef.withPolicyMixin + +```jsonnet +escalationChainRef.withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for referencing. +#### obj escalationChainRef.policy + + +##### fn escalationChainRef.policy.withResolution + +```jsonnet +escalationChainRef.policy.withResolution(value="Required") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Required"` + - valid values: `"Required"`, `"Optional"` + +Resolution specifies whether resolution of this reference is required. +The default is 'Required', which means the reconcile will fail if the +reference cannot be resolved. 'Optional' means this reference will be +a no-op if it cannot be resolved. +##### fn escalationChainRef.policy.withResolve + +```jsonnet +escalationChainRef.policy.withResolve(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Always"`, `"IfNotPresent"` + +Resolve specifies when this reference should be resolved. The default +is 'IfNotPresent', which will attempt to resolve the reference only when +the corresponding field is not present. Use 'Always' to resolve the +reference on every reconcile. +### obj escalationChainSelector + + +#### fn escalationChainSelector.withMatchControllerRef + +```jsonnet +escalationChainSelector.withMatchControllerRef(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +MatchControllerRef ensures an object with the same controller reference +as the selecting object is selected. +#### fn escalationChainSelector.withMatchLabels + +```jsonnet +escalationChainSelector.withMatchLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + +MatchLabels ensures an object with matching labels is selected. +#### fn escalationChainSelector.withMatchLabelsMixin + +```jsonnet +escalationChainSelector.withMatchLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +MatchLabels ensures an object with matching labels is selected. +#### fn escalationChainSelector.withPolicy + +```jsonnet +escalationChainSelector.withPolicy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for selection. +#### fn escalationChainSelector.withPolicyMixin + +```jsonnet +escalationChainSelector.withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for selection. +#### obj escalationChainSelector.policy + + +##### fn escalationChainSelector.policy.withResolution + +```jsonnet +escalationChainSelector.policy.withResolution(value="Required") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Required"` + - valid values: `"Required"`, `"Optional"` + +Resolution specifies whether resolution of this reference is required. +The default is 'Required', which means the reconcile will fail if the +reference cannot be resolved. 'Optional' means this reference will be +a no-op if it cannot be resolved. +##### fn escalationChainSelector.policy.withResolve + +```jsonnet +escalationChainSelector.policy.withResolve(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Always"`, `"IfNotPresent"` + +Resolve specifies when this reference should be resolved. The default +is 'IfNotPresent', which will attempt to resolve the reference only when +the corresponding field is not present. Use 'Always' to resolve the +reference on every reconcile. \ No newline at end of file diff --git a/docs/oncall/integration/defaultRoute/msteams.md b/docs/oncall/integration/defaultRoute/msteams.md new file mode 100644 index 0000000..3ecf5af --- /dev/null +++ b/docs/oncall/integration/defaultRoute/msteams.md @@ -0,0 +1,36 @@ +# msteams + + + +## Index + +* [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withId(value)`](#fn-withid) + +## Fields + +### fn withEnabled + +```jsonnet +withEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Enable notification in MS teams. Defaults to true. +Enable notification in MS teams. Defaults to `true`. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of this resource. +MS teams channel id. Alerts will be directed to this channel in Microsoft teams. \ No newline at end of file diff --git a/docs/oncall/integration/defaultRoute/slack.md b/docs/oncall/integration/defaultRoute/slack.md new file mode 100644 index 0000000..e0307df --- /dev/null +++ b/docs/oncall/integration/defaultRoute/slack.md @@ -0,0 +1,36 @@ +# slack + + + +## Index + +* [`fn withChannelId(value)`](#fn-withchannelid) +* [`fn withEnabled(value=true)`](#fn-withenabled) + +## Fields + +### fn withChannelId + +```jsonnet +withChannelId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Slack channel id. Alerts will be directed to this channel in Slack. +Slack channel id. Alerts will be directed to this channel in Slack. +### fn withEnabled + +```jsonnet +withEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Enable notification in MS teams. Defaults to true. +Enable notification in Slack. Defaults to `true`. \ No newline at end of file diff --git a/docs/oncall/integration/defaultRoute/telegram.md b/docs/oncall/integration/defaultRoute/telegram.md new file mode 100644 index 0000000..66b0cbc --- /dev/null +++ b/docs/oncall/integration/defaultRoute/telegram.md @@ -0,0 +1,36 @@ +# telegram + + + +## Index + +* [`fn withEnabled(value=true)`](#fn-withenabled) +* [`fn withId(value)`](#fn-withid) + +## Fields + +### fn withEnabled + +```jsonnet +withEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +(Boolean) Enable notification in MS teams. Defaults to true. +Enable notification in Telegram. Defaults to `true`. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) The ID of this resource. +Telegram channel id. Alerts will be directed to this channel in Telegram. \ No newline at end of file diff --git a/docs/oncall/integration/templates/email.md b/docs/oncall/integration/templates/email.md new file mode 100644 index 0000000..794c3e5 --- /dev/null +++ b/docs/oncall/integration/templates/email.md @@ -0,0 +1,35 @@ +# email + + + +## 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/oncall/integration/templates/index.md b/docs/oncall/integration/templates/index.md new file mode 100644 index 0000000..b40828b --- /dev/null +++ b/docs/oncall/integration/templates/index.md @@ -0,0 +1,280 @@ +# templates + + + +## Subpackages + +* [email](email.md) +* [microsoftTeams](microsoftTeams.md) +* [mobileApp](mobileApp.md) +* [phoneCall](phoneCall.md) +* [slack](slack.md) +* [sms](sms.md) +* [telegram](telegram.md) +* [web](web.md) + +## Index + +* [`fn withAcknowledgeSignal(value)`](#fn-withacknowledgesignal) +* [`fn withEmail(value)`](#fn-withemail) +* [`fn withEmailMixin(value)`](#fn-withemailmixin) +* [`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) +* [`fn withSlack(value)`](#fn-withslack) +* [`fn withSlackMixin(value)`](#fn-withslackmixin) +* [`fn withSms(value)`](#fn-withsms) +* [`fn withSmsMixin(value)`](#fn-withsmsmixin) +* [`fn withSourceLink(value)`](#fn-withsourcelink) +* [`fn withTelegram(value)`](#fn-withtelegram) +* [`fn withTelegramMixin(value)`](#fn-withtelegrammixin) +* [`fn withWeb(value)`](#fn-withweb) +* [`fn withWebMixin(value)`](#fn-withwebmixin) + +## Fields + +### fn withAcknowledgeSignal + +```jsonnet +withAcknowledgeSignal(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for sending a signal to acknowledge the Incident. +Template for sending a signal to acknowledge the Incident. +### fn withEmail + +```jsonnet +withEmail(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Email. (see below for nested schema) +Templates for Email. +### fn withEmailMixin + +```jsonnet +withEmailMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Email. (see below for nested schema) +Templates for Email. +### fn withGroupingKey + +```jsonnet +withGroupingKey(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for the key by which alerts are grouped. +Template for the key by which alerts are grouped. +### fn withMicrosoftTeams + +```jsonnet +withMicrosoftTeams(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(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 +withMicrosoftTeamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(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 +withPhoneCall(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Phone Call. (see below for nested schema) +Templates for Phone Call. +### fn withPhoneCallMixin + +```jsonnet +withPhoneCallMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Phone Call. (see below for nested schema) +Templates for Phone Call. +### fn withResolveSignal + +```jsonnet +withResolveSignal(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for sending a signal to resolve the Incident. +Template for sending a signal to resolve the Incident. +### fn withSlack + +```jsonnet +withSlack(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Templates for Slack. +### fn withSlackMixin + +```jsonnet +withSlackMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Templates for Slack. +### fn withSms + +```jsonnet +withSms(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for SMS. (see below for nested schema) +Templates for SMS. +### fn withSmsMixin + +```jsonnet +withSmsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for SMS. (see below for nested schema) +Templates for SMS. +### fn withSourceLink + +```jsonnet +withSourceLink(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for a source link. +Template for a source link. +### fn withTelegram + +```jsonnet +withTelegram(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Templates for Telegram. +### fn withTelegramMixin + +```jsonnet +withTelegramMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +specific settings for a route. (see below for nested schema) +Templates for Telegram. +### fn withWeb + +```jsonnet +withWeb(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Web. (see below for nested schema) +Templates for Web. +### fn withWebMixin + +```jsonnet +withWebMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +(Block List, Max: 1) Templates for Web. (see below for nested schema) +Templates for Web. \ No newline at end of file diff --git a/docs/oncall/integration/templates/microsoftTeams.md b/docs/oncall/integration/templates/microsoftTeams.md new file mode 100644 index 0000000..12fda25 --- /dev/null +++ b/docs/oncall/integration/templates/microsoftTeams.md @@ -0,0 +1,48 @@ +# microsoftTeams + + + +## Index + +* [`fn withImageUrl(value)`](#fn-withimageurl) +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withImageUrl + +```jsonnet +withImageUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert image url. +Template for Alert image url. +### 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/oncall/integration/templates/mobileApp.md b/docs/oncall/integration/templates/mobileApp.md new file mode 100644 index 0000000..58619d3 --- /dev/null +++ b/docs/oncall/integration/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/oncall/integration/templates/phoneCall.md b/docs/oncall/integration/templates/phoneCall.md new file mode 100644 index 0000000..381d2d8 --- /dev/null +++ b/docs/oncall/integration/templates/phoneCall.md @@ -0,0 +1,22 @@ +# phoneCall + + + +## Index + +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### 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/oncall/integration/templates/slack.md b/docs/oncall/integration/templates/slack.md new file mode 100644 index 0000000..15d3ba5 --- /dev/null +++ b/docs/oncall/integration/templates/slack.md @@ -0,0 +1,48 @@ +# slack + + + +## Index + +* [`fn withImageUrl(value)`](#fn-withimageurl) +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withImageUrl + +```jsonnet +withImageUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert image url. +Template for Alert image url. +### 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/oncall/integration/templates/sms.md b/docs/oncall/integration/templates/sms.md new file mode 100644 index 0000000..7011ae3 --- /dev/null +++ b/docs/oncall/integration/templates/sms.md @@ -0,0 +1,22 @@ +# sms + + + +## Index + +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### 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/oncall/integration/templates/telegram.md b/docs/oncall/integration/templates/telegram.md new file mode 100644 index 0000000..931fb64 --- /dev/null +++ b/docs/oncall/integration/templates/telegram.md @@ -0,0 +1,48 @@ +# telegram + + + +## Index + +* [`fn withImageUrl(value)`](#fn-withimageurl) +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withImageUrl + +```jsonnet +withImageUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert image url. +Template for Alert image url. +### 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/oncall/integration/templates/web.md b/docs/oncall/integration/templates/web.md new file mode 100644 index 0000000..c7102ef --- /dev/null +++ b/docs/oncall/integration/templates/web.md @@ -0,0 +1,48 @@ +# web + + + +## Index + +* [`fn withImageUrl(value)`](#fn-withimageurl) +* [`fn withMessage(value)`](#fn-withmessage) +* [`fn withTitle(value)`](#fn-withtitle) + +## Fields + +### fn withImageUrl + +```jsonnet +withImageUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Template for Alert image url. +Template for Alert image url. +### 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/oncall/schedule/shiftsRef.md b/docs/oncall/schedule/shiftsRef.md new file mode 100644 index 0000000..1ec53f3 --- /dev/null +++ b/docs/oncall/schedule/shiftsRef.md @@ -0,0 +1,82 @@ +# shiftsRef + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPolicy(value)`](#fn-withpolicy) +* [`fn withPolicyMixin(value)`](#fn-withpolicymixin) +* [`obj policy`](#obj-policy) + * [`fn withResolution(value="Required")`](#fn-policywithresolution) + * [`fn withResolve(value)`](#fn-policywithresolve) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the referenced object. +### fn withPolicy + +```jsonnet +withPolicy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for referencing. +### fn withPolicyMixin + +```jsonnet +withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Policies for referencing. +### obj policy + + +#### fn policy.withResolution + +```jsonnet +policy.withResolution(value="Required") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Required"` + - valid values: `"Required"`, `"Optional"` + +Resolution specifies whether resolution of this reference is required. +The default is 'Required', which means the reconcile will fail if the +reference cannot be resolved. 'Optional' means this reference will be +a no-op if it cannot be resolved. +#### fn policy.withResolve + +```jsonnet +policy.withResolve(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Always"`, `"IfNotPresent"` + +Resolve specifies when this reference should be resolved. The default +is 'IfNotPresent', which will attempt to resolve the reference only when +the corresponding field is not present. Use 'Always' to resolve the +reference on every reconcile. \ No newline at end of file diff --git a/docs/oncall/schedule/slack.md b/docs/oncall/schedule/slack.md new file mode 100644 index 0000000..669f0ea --- /dev/null +++ b/docs/oncall/schedule/slack.md @@ -0,0 +1,35 @@ +# slack + + + +## Index + +* [`fn withChannelId(value)`](#fn-withchannelid) +* [`fn withUserGroupId(value)`](#fn-withusergroupid) + +## Fields + +### fn withChannelId + +```jsonnet +withChannelId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +(String) Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack. +Slack channel id. Reminder about schedule shifts will be directed to this channel in Slack. +### fn withUserGroupId + +```jsonnet +withUserGroupId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +call users change. +Slack user group id. Members of user group will be updated when on-call users change. \ No newline at end of file