JSON schema Bolt Schedules

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"title": "Bolt Schedules",
	"description": "Define Bolt schedules in YAML",
	"type": "object",
	"required": [
		"schedules"
	],
	"properties": {
		"schedules": {
			"description": "List of schedules",
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"description": "The name of the schedule.",
						"type": "string"
					},
					"turbo_ci": {
						"description": "Specify if this is a Turbo CI job.",
						"type": "object",
						"properties": {
							"enabled": {
								"description": "Turn on Turbo CI",
								"type": "boolean"
							},
							"deferred_manifest_schedule": {
								"description": "[DEPRECATED] Use `deferred_schedule_name` instead. The schedule name to defer from, can be the same as this schedule if you want to defer from itself.",
								"type": "string",
								"deprecated": true
							},
							"deferred_schedule_name": {
								"description": "The schedule name to defer from, can be the same as this schedule if you want to defer from itself.",
								"type": "string"
							},
							"successful_runs_only": {
								"description": "By default paradime will look for the last successful run. Set this to `false` to let paradime to use defer with last run of the selected schedule, irrespective of the run status.",
								"type": "boolean"
							}
						},
						"required": [
							"enabled"
						],
						"oneOf": [
							{
								"required": [
									"deferred_manifest_schedule"
								]
							},
							{
								"required": [
									"deferred_schedule_name"
								]
							}
						]
					},
					"deferred": {
						"description": "Specify if this is a Turbo CI job.",
						"type": "object",
						"properties": {
							"enabled": {
								"description": "Set this to `true` to enable deferring for the schedule",
								"type": "boolean"
							},
							"deferred_manifest_schedule": {
								"description": "[DEPRECATED] Use `deferred_schedule_name` instead. The name of the Bolt schedule used to look for the most recent successful run manifest.json / sources.json / run_results.json for state comparison. It can be another schedule or the using the same schedule name (self-defering).",
								"type": "string",
								"deprecated": true
							},
							"deferred_schedule_name": {
								"description": "The name of the Bolt schedule used to look for the most recent successful run manifest.json / sources.json / run_results.json for state comparison. It can be another schedule or the using the same schedule name (self-defering).",
								"type": "string"
							},
							"successful_runs_only": {
								"description": "By default paradime will look for the last successful run. Set this to `false` to let paradime to use defer with last run of the selected schedule, irrespective of the run status.",
								"type": "boolean"
							}
						},
						"required": [
							"enabled"
						],
						"oneOf": [
							{
								"required": [
									"deferred_manifest_schedule"
								]
							},
							{
								"required": [
									"deferred_schedule_name"
								]
							}
						]
					},
					"schedule": {
						"description": "The cron definition of the schedule. Use https://crontab.guru to build your cron schedule.",
						"type": "string"
					},
					"timezone": {
						"description": "The timezone in which the schedule will run. Defaults to UTC.",
						"type": "string",
						"enum": [
							"Africa/Accra",
							"Africa/Addis_Ababa",
							"Africa/Algiers",
							"Africa/Asmara",
							"Africa/Asmera",
							"Africa/Bamako",
							"Africa/Bangui",
							"Africa/Banjul",
							"Africa/Bissau",
							"Africa/Blantyre",
							"Africa/Brazzaville",
							"Africa/Bujumbura",
							"Africa/Cairo",
							"Africa/Casablanca",
							"Africa/Ceuta",
							"Africa/Conakry",
							"Africa/Dakar",
							"Africa/Dar_es_Salaam",
							"Africa/Djibouti",
							"Africa/Douala",
							"Africa/El_Aaiun",
							"Africa/Freetown",
							"Africa/Gaborone",
							"Africa/Harare",
							"Africa/Johannesburg",
							"Africa/Juba",
							"Africa/Kampala",
							"Africa/Khartoum",
							"Africa/Kigali",
							"Africa/Kinshasa",
							"Africa/Lagos",
							"Africa/Libreville",
							"Africa/Lome",
							"Africa/Luanda",
							"Africa/Lubumbashi",
							"Africa/Lusaka",
							"Africa/Malabo",
							"Africa/Maputo",
							"Africa/Maseru",
							"Africa/Mbabane",
							"Africa/Mogadishu",
							"Africa/Monrovia",
							"Africa/Nairobi",
							"Africa/Ndjamena",
							"Africa/Niamey",
							"Africa/Nouakchott",
							"Africa/Ouagadougou",
							"Africa/Porto-Novo",
							"Africa/Sao_Tome",
							"Africa/Timbuktu",
							"Africa/Tripoli",
							"Africa/Tunis",
							"Africa/Windhoek",
							"America/Adak",
							"America/Anchorage",
							"America/Anguilla",
							"America/Antigua",
							"America/Araguaina",
							"America/Argentina/Buenos_Aires",
							"America/Argentina/Catamarca",
							"America/Argentina/ComodRivadavia",
							"America/Argentina/Cordoba",
							"America/Argentina/Jujuy",
							"America/Argentina/La_Rioja",
							"America/Argentina/Mendoza",
							"America/Argentina/Rio_Gallegos",
							"America/Argentina/Salta",
							"America/Argentina/San_Juan",
							"America/Argentina/San_Luis",
							"America/Argentina/Tucuman",
							"America/Argentina/Ushuaia",
							"America/Aruba",
							"America/Asuncion",
							"America/Atikokan",
							"America/Atka",
							"America/Bahia",
							"America/Bahia_Banderas",
							"America/Barbados",
							"America/Belem",
							"America/Belize",
							"America/Blanc-Sablon",
							"America/Boa_Vista",
							"America/Bogota",
							"America/Boise",
							"America/Buenos_Aires",
							"America/Cambridge_Bay",
							"America/Campo_Grande",
							"America/Cancun",
							"America/Caracas",
							"America/Catamarca",
							"America/Cayenne",
							"America/Cayman",
							"America/Chicago",
							"America/Chihuahua",
							"America/Ciudad_Juarez",
							"America/Coral_Harbour",
							"America/Cordoba",
							"America/Costa_Rica",
							"America/Coyhaique",
							"America/Creston",
							"America/Cuiaba",
							"America/Curacao",
							"America/Danmarkshavn",
							"America/Dawson",
							"America/Dawson_Creek",
							"America/Denver",
							"America/Detroit",
							"America/Dominica",
							"America/Edmonton",
							"America/Eirunepe",
							"America/El_Salvador",
							"America/Ensenada",
							"America/Fort_Nelson",
							"America/Fort_Wayne",
							"America/Fortaleza",
							"America/Glace_Bay",
							"America/Godthab",
							"America/Goose_Bay",
							"America/Grand_Turk",
							"America/Grenada",
							"America/Guadeloupe",
							"America/Guatemala",
							"America/Guayaquil",
							"America/Guyana",
							"America/Halifax",
							"America/Havana",
							"America/Hermosillo",
							"America/Indiana/Indianapolis",
							"America/Indiana/Knox",
							"America/Indiana/Marengo",
							"America/Indiana/Petersburg",
							"America/Indiana/Tell_City",
							"America/Indiana/Vevay",
							"America/Indiana/Vincennes",
							"America/Indiana/Winamac",
							"America/Indianapolis",
							"America/Inuvik",
							"America/Iqaluit",
							"America/Jamaica",
							"America/Jujuy",
							"America/Juneau",
							"America/Kentucky/Louisville",
							"America/Kentucky/Monticello",
							"America/Knox_IN",
							"America/Kralendijk",
							"America/La_Paz",
							"America/Lima",
							"America/Los_Angeles",
							"America/Louisville",
							"America/Lower_Princes",
							"America/Maceio",
							"America/Managua",
							"America/Manaus",
							"America/Marigot",
							"America/Martinique",
							"America/Matamoros",
							"America/Mazatlan",
							"America/Mendoza",
							"America/Menominee",
							"America/Merida",
							"America/Metlakatla",
							"America/Mexico_City",
							"America/Miquelon",
							"America/Moncton",
							"America/Monterrey",
							"America/Montevideo",
							"America/Montreal",
							"America/Montserrat",
							"America/Nassau",
							"America/New_York",
							"America/Nipigon",
							"America/Nome",
							"America/Noronha",
							"America/North_Dakota/Beulah",
							"America/North_Dakota/Center",
							"America/North_Dakota/New_Salem",
							"America/Nuuk",
							"America/Ojinaga",
							"America/Panama",
							"America/Pangnirtung",
							"America/Paramaribo",
							"America/Phoenix",
							"America/Port_of_Spain",
							"America/Port-au-Prince",
							"America/Porto_Acre",
							"America/Porto_Velho",
							"America/Puerto_Rico",
							"America/Punta_Arenas",
							"America/Rainy_River",
							"America/Rankin_Inlet",
							"America/Recife",
							"America/Regina",
							"America/Resolute",
							"America/Rio_Branco",
							"America/Rosario",
							"America/Santa_Isabel",
							"America/Santarem",
							"America/Santiago",
							"America/Santo_Domingo",
							"America/Sao_Paulo",
							"America/Scoresbysund",
							"America/Shiprock",
							"America/Sitka",
							"America/St_Barthelemy",
							"America/St_Johns",
							"America/St_Kitts",
							"America/St_Lucia",
							"America/St_Thomas",
							"America/St_Vincent",
							"America/Swift_Current",
							"America/Tegucigalpa",
							"America/Thule",
							"America/Thunder_Bay",
							"America/Tijuana",
							"America/Toronto",
							"America/Tortola",
							"America/Vancouver",
							"America/Virgin",
							"America/Whitehorse",
							"America/Winnipeg",
							"America/Yakutat",
							"America/Yellowknife",
							"Antarctica/Casey",
							"Antarctica/Davis",
							"Antarctica/DumontDUrville",
							"Antarctica/Macquarie",
							"Antarctica/Mawson",
							"Antarctica/McMurdo",
							"Antarctica/Palmer",
							"Antarctica/Rothera",
							"Antarctica/South_Pole",
							"Antarctica/Syowa",
							"Antarctica/Troll",
							"Antarctica/Vostok",
							"Arctic/Longyearbyen",
							"Asia/Aden",
							"Asia/Almaty",
							"Asia/Amman",
							"Asia/Anadyr",
							"Asia/Aqtau",
							"Asia/Aqtobe",
							"Asia/Ashgabat",
							"Asia/Ashkhabad",
							"Asia/Atyrau",
							"Asia/Baghdad",
							"Asia/Bahrain",
							"Asia/Baku",
							"Asia/Bangkok",
							"Asia/Barnaul",
							"Asia/Beirut",
							"Asia/Bishkek",
							"Asia/Brunei",
							"Asia/Calcutta",
							"Asia/Chita",
							"Asia/Choibalsan",
							"Asia/Chongqing",
							"Asia/Chungking",
							"Asia/Colombo",
							"Asia/Dacca",
							"Asia/Damascus",
							"Asia/Dhaka",
							"Asia/Dili",
							"Asia/Dubai",
							"Asia/Dushanbe",
							"Asia/Famagusta",
							"Asia/Gaza",
							"Asia/Harbin",
							"Asia/Hebron",
							"Asia/Ho_Chi_Minh",
							"Asia/Hong_Kong",
							"Asia/Hovd",
							"Asia/Irkutsk",
							"Asia/Istanbul",
							"Asia/Jakarta",
							"Asia/Jayapura",
							"Asia/Jerusalem",
							"Asia/Kabul",
							"Asia/Kamchatka",
							"Asia/Karachi",
							"Asia/Kashgar",
							"Asia/Kathmandu",
							"Asia/Katmandu",
							"Asia/Khandyga",
							"Asia/Kolkata",
							"Asia/Krasnoyarsk",
							"Asia/Kuala_Lumpur",
							"Asia/Kuching",
							"Asia/Kuwait",
							"Asia/Macao",
							"Asia/Macau",
							"Asia/Magadan",
							"Asia/Makassar",
							"Asia/Manila",
							"Asia/Muscat",
							"Asia/Nicosia",
							"Asia/Novokuznetsk",
							"Asia/Novosibirsk",
							"Asia/Omsk",
							"Asia/Oral",
							"Asia/Phnom_Penh",
							"Asia/Pontianak",
							"Asia/Pyongyang",
							"Asia/Qatar",
							"Asia/Qostanay",
							"Asia/Qyzylorda",
							"Asia/Rangoon",
							"Asia/Riyadh",
							"Asia/Saigon",
							"Asia/Sakhalin",
							"Asia/Samarkand",
							"Asia/Seoul",
							"Asia/Shanghai",
							"Asia/Singapore",
							"Asia/Srednekolymsk",
							"Asia/Taipei",
							"Asia/Tashkent",
							"Asia/Tbilisi",
							"Asia/Tehran",
							"Asia/Tel_Aviv",
							"Asia/Thimbu",
							"Asia/Thimphu",
							"Asia/Tokyo",
							"Asia/Tomsk",
							"Asia/Ujung_Pandang",
							"Asia/Ulaanbaatar",
							"Asia/Ulan_Bator",
							"Asia/Urumqi",
							"Asia/Ust-Nera",
							"Asia/Vientiane",
							"Asia/Vladivostok",
							"Asia/Yakutsk",
							"Asia/Yangon",
							"Asia/Yekaterinburg",
							"Asia/Yerevan",
							"Atlantic/Azores",
							"Atlantic/Bermuda",
							"Atlantic/Canary",
							"Atlantic/Cape_Verde",
							"Atlantic/Faeroe",
							"Atlantic/Faroe",
							"Atlantic/Jan_Mayen",
							"Atlantic/Madeira",
							"Atlantic/Reykjavik",
							"Atlantic/South_Georgia",
							"Atlantic/St_Helena",
							"Atlantic/Stanley",
							"Australia/ACT",
							"Australia/Adelaide",
							"Australia/Brisbane",
							"Australia/Broken_Hill",
							"Australia/Canberra",
							"Australia/Currie",
							"Australia/Darwin",
							"Australia/Eucla",
							"Australia/Hobart",
							"Australia/LHI",
							"Australia/Lindeman",
							"Australia/Lord_Howe",
							"Australia/Melbourne",
							"Australia/North",
							"Australia/NSW",
							"Australia/Perth",
							"Australia/Queensland",
							"Australia/South",
							"Australia/Sydney",
							"Australia/Tasmania",
							"Australia/Victoria",
							"Australia/West",
							"Australia/Yancowinna",
							"Brazil/Acre",
							"Brazil/DeNoronha",
							"Brazil/East",
							"Brazil/West",
							"Canada/Atlantic",
							"Canada/Central",
							"Canada/Eastern",
							"Canada/Mountain",
							"Canada/Newfoundland",
							"Canada/Pacific",
							"Canada/Saskatchewan",
							"Canada/Yukon",
							"CET",
							"Chile/Continental",
							"Chile/EasterIsland",
							"CST6CDT",
							"Cuba",
							"EET",
							"Egypt",
							"Eire",
							"EST",
							"EST5EDT",
							"Etc/GMT",
							"Etc/GMT-0",
							"Etc/GMT-1",
							"Etc/GMT-2",
							"Etc/GMT-3",
							"Etc/GMT-4",
							"Etc/GMT-5",
							"Etc/GMT-6",
							"Etc/GMT-7",
							"Etc/GMT-8",
							"Etc/GMT-9",
							"Etc/GMT-10",
							"Etc/GMT-11",
							"Etc/GMT-12",
							"Etc/GMT-13",
							"Etc/GMT-14",
							"Etc/GMT+0",
							"Etc/GMT+1",
							"Etc/GMT+2",
							"Etc/GMT+3",
							"Etc/GMT+4",
							"Etc/GMT+5",
							"Etc/GMT+6",
							"Etc/GMT+7",
							"Etc/GMT+8",
							"Etc/GMT+9",
							"Etc/GMT+10",
							"Etc/GMT+11",
							"Etc/GMT+12",
							"Etc/GMT0",
							"Etc/Greenwich",
							"Etc/UCT",
							"Etc/Universal",
							"Etc/UTC",
							"Etc/Zulu",
							"Europe/Amsterdam",
							"Europe/Andorra",
							"Europe/Astrakhan",
							"Europe/Athens",
							"Europe/Belfast",
							"Europe/Belgrade",
							"Europe/Berlin",
							"Europe/Bratislava",
							"Europe/Brussels",
							"Europe/Bucharest",
							"Europe/Budapest",
							"Europe/Busingen",
							"Europe/Chisinau",
							"Europe/Copenhagen",
							"Europe/Dublin",
							"Europe/Gibraltar",
							"Europe/Guernsey",
							"Europe/Helsinki",
							"Europe/Isle_of_Man",
							"Europe/Istanbul",
							"Europe/Jersey",
							"Europe/Kaliningrad",
							"Europe/Kiev",
							"Europe/Kirov",
							"Europe/Kyiv",
							"Europe/Lisbon",
							"Europe/Ljubljana",
							"Europe/London",
							"Europe/Luxembourg",
							"Europe/Madrid",
							"Europe/Malta",
							"Europe/Mariehamn",
							"Europe/Minsk",
							"Europe/Monaco",
							"Europe/Moscow",
							"Europe/Nicosia",
							"Europe/Oslo",
							"Europe/Paris",
							"Europe/Podgorica",
							"Europe/Prague",
							"Europe/Riga",
							"Europe/Rome",
							"Europe/Samara",
							"Europe/San_Marino",
							"Europe/Sarajevo",
							"Europe/Saratov",
							"Europe/Simferopol",
							"Europe/Skopje",
							"Europe/Sofia",
							"Europe/Stockholm",
							"Europe/Tallinn",
							"Europe/Tirane",
							"Europe/Tiraspol",
							"Europe/Ulyanovsk",
							"Europe/Uzhgorod",
							"Europe/Vaduz",
							"Europe/Vatican",
							"Europe/Vienna",
							"Europe/Vilnius",
							"Europe/Volgograd",
							"Europe/Warsaw",
							"Europe/Zagreb",
							"Europe/Zaporozhye",
							"Europe/Zurich",
							"Factory",
							"GB",
							"GB-Eire",
							"GMT",
							"GMT-0",
							"GMT+0",
							"GMT0",
							"Greenwich",
							"Hongkong",
							"HST",
							"Iceland",
							"Indian/Antananarivo",
							"Indian/Chagos",
							"Indian/Christmas",
							"Indian/Cocos",
							"Indian/Comoro",
							"Indian/Kerguelen",
							"Indian/Mahe",
							"Indian/Maldives",
							"Indian/Mauritius",
							"Indian/Mayotte",
							"Indian/Reunion",
							"Iran",
							"Israel",
							"Jamaica",
							"Japan",
							"Kwajalein",
							"Libya",
							"MET",
							"Mexico/BajaNorte",
							"Mexico/BajaSur",
							"Mexico/General",
							"MST",
							"MST7MDT",
							"Navajo",
							"NZ",
							"NZ-CHAT",
							"Pacific/Apia",
							"Pacific/Auckland",
							"Pacific/Bougainville",
							"Pacific/Chatham",
							"Pacific/Chuuk",
							"Pacific/Easter",
							"Pacific/Efate",
							"Pacific/Enderbury",
							"Pacific/Fakaofo",
							"Pacific/Fiji",
							"Pacific/Funafuti",
							"Pacific/Galapagos",
							"Pacific/Gambier",
							"Pacific/Guadalcanal",
							"Pacific/Guam",
							"Pacific/Honolulu",
							"Pacific/Johnston",
							"Pacific/Kanton",
							"Pacific/Kiritimati",
							"Pacific/Kosrae",
							"Pacific/Kwajalein",
							"Pacific/Majuro",
							"Pacific/Marquesas",
							"Pacific/Midway",
							"Pacific/Nauru",
							"Pacific/Niue",
							"Pacific/Norfolk",
							"Pacific/Noumea",
							"Pacific/Pago_Pago",
							"Pacific/Palau",
							"Pacific/Pitcairn",
							"Pacific/Pohnpei",
							"Pacific/Ponape",
							"Pacific/Port_Moresby",
							"Pacific/Rarotonga",
							"Pacific/Saipan",
							"Pacific/Samoa",
							"Pacific/Tahiti",
							"Pacific/Tarawa",
							"Pacific/Tongatapu",
							"Pacific/Truk",
							"Pacific/Wake",
							"Pacific/Wallis",
							"Pacific/Yap",
							"Poland",
							"Portugal",
							"PRC",
							"PST8PDT",
							"ROC",
							"ROK",
							"Singapore",
							"Turkey",
							"UCT",
							"Universal",
							"US/Alaska",
							"US/Aleutian",
							"US/Arizona",
							"US/Central",
							"US/East-Indiana",
							"US/Eastern",
							"US/Hawaii",
							"US/Indiana-Starke",
							"US/Michigan",
							"US/Mountain",
							"US/Pacific",
							"US/Samoa",
							"UTC",
							"W-SU",
							"WET",
							"Zulu"
						]
					},
					"environment": {
						"description": "This defaults to `production` for now.",
						"const": "production"
					},
					"commands": {
						"description": "The commands to run in the schedule. Can be dbt, edr and any other supported CLI command.",
						"type": "array",
						"items": {
							"type": "string"
						}
					},
					"owner_email": {
						"description": "The email of the person owning the schedule.",
						"type": "string"
					},
					"git_branch": {
						"description": "The git branch against which this schedule will be run.",
						"type": "string"
					},
					"slack_notify": {
						"description": "This is optional and only works when Slack is connected. Should be a list of Slack user handles and channels e.g. @kaustav or #alerts.",
						"type": "array",
						"items": {
							"type": "string"
						},
						"minItems": 1,
						"uniqueItems": true
					},
					"slack_on": {
						"description": "The conditions under which we will notify on Slack - one of passed or failed.",
						"type": "array",
						"items": {
							"type": "string",
							"enum": [
								"failed",
								"passed"
							]
						},
						"minItems": 1,
						"uniqueItems": true
					},
					"email_notify": {
						"description": "The list of emails we will notify.",
						"type": "array",
						"items": {
							"type": "string"
						},
						"minItems": 1,
						"uniqueItems": true
					},
					"email_on": {
						"description": "The conditions under which we will notify on Email - one of passed or failed.",
						"type": "array",
						"items": {
							"type": "string",
							"enum": [
								"failed",
								"passed"
							]
						},
						"minItems": 1,
						"uniqueItems": true
					}
				},
				"required": [
					"name",
					"schedule",
					"environment",
					"commands",
					"owner_email"
				]
			}
		}
	}
}

Last updated

Was this helpful?