phasedRelease

Property Manager name: Phased Release Cloudlet
Behavior version: The v2024-10-21 rule format supports the phasedRelease behavior v2.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the Cloudlets API or the Cloudlets Policy Manager application within Control Center to set up your Cloudlets policies.

Option	Type	Description	Requires
`enabled`	boolean	Enables the Phased Release Cloudlet.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`isSharedPolicy`	boolean	Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in Cloudlets Policy Manager.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`cloudletPolicy`	object	Specifies the Cloudlet policy as an object.	`isSharedPolicy` is `false`	{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"isSharedPolicy","op":"eq","value":false}}
`cloudletPolicy.id`	number	Identifies the Cloudlet.
`cloudletPolicy.name`	string	The Cloudlet's descriptive name.
`cloudletSharedPolicy`	string	Identifies the Cloudlet shared policy to use with this behavior. Use the Cloudlets API to list available shared policies.	`isSharedPolicy` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"isSharedPolicy","op":"eq","value":true}}
`label`	string	A label to distinguish this Phased Release policy from any others within the same property.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`populationCookieType`	enum	Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's random membership option, it overrides this option's value so that it is effectively `NONE`.		{"displayType":"enum","options":["NONE","NEVER","ON_BROWSER_CLOSE","FIXED_DATE","DURATION"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`NONE`	Do not expire the cookie.
	`NEVER`	Never assign a cookie.
	`ON_BROWSER_CLOSE`	Once the browser session ends.
	`FIXED_DATE`	Specify a time when the cookie expires.
	`DURATION`	Specify a delay before the cookie expires.
`populationExpirationDate`	string (epoch timestamp)	Specifies the date and time when membership expires, and the browser no longer sends the cookie. Subsequent requests re-evaluate based on current membership settings.	`populationCookieType` is `FIXED_DATE`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"FIXED_DATE"}]}}
`populationDuration`	string (duration)	Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.	`populationCookieType` is `DURATION`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}
`populationRefresh`	boolean	Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.	`populationCookieType` is `DURATION`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"populationCookieType","op":"eq","value":"DURATION"}]}}
`failoverEnabled`	boolean	Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`failoverResponseCode`	string array	Defines the set of failure codes that initiate the failover response.	`failoverEnabled` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverEnabled","op":"eq","value":true}]}}
`failoverDuration`	number (0-300)	Specifies the number of seconds to wait until the client tries to access the failover origin after the initial failure is detected. Set the value to `0` to immediately request the alternate origin upon failure.	`failoverEnabled` is `true`	{"displayType":"number","max":[300],"min":[0],"tag":"input","type":"range"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverEnabled","op":"eq","value":true}]}}