Global - Documentation

Type Definitions

appPatchedPropsType

Source:

types.js, line 174

Properties:

Name	Type	Attributes	Description
`cpus`	number		In millicores.
`memory`	number		In megabytes.
`memoryLimit`	number		In megabytes.
`cpusLimit`	number		In millicores.
`storage`	number		In megabytes.
`storageLimit`	number		In megabytes.
`egressLimit`	number		In megabytes/sec
`image`	string		Docker image.
`poolKey`	string
`poolValue`	string
`isGvisor`	boolean		Whether to use a sandbox.
`isIncubator`	boolean
`instances`	number		The number of processes.
`props`	string	<optional>	JSON serialized metadata of current deployment

Type:

Object

appPropsType

Source:

types.js, line 124

Properties:

Name	Type	Attributes	Description
`id`	string		// duplicate
`k8SNamespace`	string		The app namespace.
`instances`	number		The number of processes.
`touch`	string		Modify to trigger reset.
`appPublisher`	string
`appLocalName`	string
`appSuffix`	string
`isDeployer`	boolean
`isAccounts`	boolean
`isPeople`	boolean
`isUntrusted`	boolean		// duplicate
`isIncubator`	boolean
`isGvisor`	boolean		Whether to use a sandbox.
`redisNamespace`	string		The redis namespace.
`image`	string
`args`	string		The JSON serialized array with arguments to node.
`cpus`	number		In millicores.
`memory`	number		In megabytes.
`memoryLimit`	number		In megabytes.
`cpusLimit`	number		In millicores.
`storage`	number		In megabytes.
`storageLimit`	number		In megabytes.
`egressLimit`	number		In megabytes/sec
`poolKey`	string
`poolValue`	string
`isCDN`	boolean		Whether to change current CDN settings.
`appCDN`	string	<optional>	The base url for a CDN service.
`appSubdirCDN`	string	<optional>	A CDN subdir for cache invalidation.
`props`	string	<optional>	JSON serialized metadata of current deployment (type before serialization is `deploymentPropsType`).
`envProps`	Array.<envPropertiesType>	<optional>	A list of properties to set.

Type:

Object

appSpecType

Source:

types.js, line 65

Properties:

Name	Type	Description
`templateFile`	string	The mustache template to patch.
`k8SNamespace`	string	The namespace for the service.
`nodePool`	poolType	The node pool.
`request`	resourcesType	The resources requested.
`limit`	resourcesType	A hard limit on the resources consumed.
`maxInstances`	number	The maximum number of app processes.
`args`	Array.<jsonType>	The arguments to the node.js process.

Type:

Object

cdnType

Source:

types.js, line 228

Properties:

Name	Type	Description
`appCDN`	string	The URL from the CDN provider.
`appSubdirCDN`	string	A subdirectory adding versioning to help cache invalidation.

Type:

Object

changeImageOptionsType

Source:

types.js, line 266

Properties:

Name	Type	Description
`id`	string
`image`	string	The new Docker image for the app.
`currentProps`	deploymentPropsType	The deployment properties currently used.

Type:

Object

createOptionsType

Source:

types.js, line 243

Properties:

Name	Type	Attributes	Description
`id`	string
`plan`	string		The strategy to flex resources.
`image`	string		The docker image for the app.
`timestamp`	string	<optional>	An optional tag to identify a previous redis service instance. This allows redis to restart from a previous state.
`isUntrusted`	boolean
`cdn`	cdnType	<optional>	An optional CDN configuration that overrides the one in the image.
`envProps`	Array.<envPropertiesType>	<optional>	A list of properties to set.

Type:

Object

deleteOptionsType

Source:

types.js, line 257

Properties:

Name	Type	Description
`id`	string
`keepData`	boolean	Do not delete the volume.
`timestamp`	string	Over time multiple instances of a service have the same `id`, and by adding `timestamp` we can identify their volumes.

Type:

Object

deploymentPropsType

Source:

types.js, line 162

Properties:

Name	Type	Attributes	Description
`version`	string		The schema version for this metadata.
`app`	appPropsType	<optional>	Props for the nodejs app.
`redis`	redisPropsType	<optional>	Props for the redis backend.
`numberOfCAs`	number		The number of active CAs.
`plan`	string		The strategy to flex resources.

Type:

Object

deploymentSpecType

Source:

types.js, line 78

Properties:

Name	Type	Description
`useK8SConfig`	boolean	Whether to use the k8s config file from the kubelet client.
`refreshInterval`	number	Time between Kubernetes status polling in msec.
`appSuffix`	string	The suffix for the app name, e.g., `cafjs.com`.
`isUntrusted`	boolean	Whether the deployment should be trusted.
`isIncubator`	boolean	Whether the deployment is in incubation mode.
`isDeployer`	boolean	Whether it is the `Deployer` app.
`isPeople`	boolean	Whether it is the `People` app.
`isAccounts`	boolean	Whether it is the `Accounts` app.
`plans`	Object.<string, number>	The threshold in CAs for an extra application process.
`ratioIncubator`	number	The portion of a full process assigned to incubator mode.
`redis`	redisSpecType	The spec for the redis backend.
`app`	appSpecType	The spec for the app processes.

Type:

Object

envPropertiesType

Source:

types.js, line 236

Properties:

Name	Type	Description
`key`	string	The key of the environment property.
`value`	string	The value of the environment property.

Type:

Object

jsonType

Source:

types.js, line 5

Type:

Object | Array | string | number | null | boolean

patchedPropsType

Source:

types.js, line 207

Properties:

Name	Type	Attributes	Description
`plan`	string		The strategy to flex resources.
`numberOfCAs`	number		The number of active CAs.
`app`	appPatchedPropsType	<optional>	Props for the nodejs app.
`redis`	redisPatchedPropsType	<optional>	Props for the redis backend.

Type:

Object

poolType

Source:

types.js, line 28

Properties:

Name	Type	Description
`poolKey`	Array.<string>	The key to select a node pool. See `cpus` for the array description.
`poolValue`	Array.<string>	The value to select a node pool. See `cpus` for the array description.
`isGvisor`	Array.<boolean>	Whether the node pool enables gvisor. See `cpus` for the array description.

Type:

Object

redisPatchedPropsType

Source:

types.js, line 193

Properties:

Name	Type	Description
`cpus`	number	In millicores.
`memory`	number	In megabytes.
`memoryLimit`	number	In megabytes.
`cpusLimit`	number	In millicores.
`poolKey`	string
`poolValue`	string
`isGvisor`	boolean	Whether to use a sandbox.
`dedicatedVolumeSize`	number	The disk size in gigabytes.

Type:

Object

redisPropsType

Source:

types.js, line 102

Properties:

Name	Type	Description
`id`	string
`k8SNamespace`	string
`touch`	string	Modify to trigger reset.
`timestamp`	string	Over time multiple instances of a service have the same `id`, and by adding `timestamp` we can identify their volumes.
`image`	string
`cpus`	number	In millicores.
`memory`	number	In megabytes.
`memoryLimit`	number	In megabytes.
`cpusLimit`	number	In millicores.
`poolKey`	string
`poolValue`	string
`dedicatedVolumeSize`	number	The disk size in gigabytes.
`isDedicatedVolume`	boolean	True if it has exclusive access to a persistent volume.
`isUntrusted`	boolean

Type:

Object

redisSpecType

Source:

types.js, line 39

Properties:

Name	Type	Description
`templateFile`	string	The mustache template to patch.
`k8SNamespace`	string	The namespace for the service.
`image`	string	The docker image for Redis.
`nodePool`	poolType	The node pool.
`request`	resourcesType	The resources requested.
`limit`	resourcesType	A hard limit on the resources consumed. Limits are only active if `isUntrusted` is true.
`updateRatio`	number	Update resources every `updateRatio` incremental number of app processes.
`deltaRequest`	resourcesType	Incremental resources requested per extra `updateRatio` processes.
`deltaLimit`	resourcesType	Incremental hard limit on the resources consumed per extra `updateRatio` processes.
`dedicatedVolumeSize`	Array.<number>	Size in gigabytes of the dedicated volume. See `cpus` for the array description.
`deltaDedicatedVolumeSize`	Array.<number>	Incremental size increase in gigabytes of the dedicated volume per extra `updateRatio` app processes.See `cpus` for the array description.
`maxNFSInstances`	number	The maximum number of app instances before we create a dedicated volume.

Type:

Object

resourcesType

Source:

types.js, line 14

Properties:

Name	Type	Attributes	Description
`cpus`	Array.<number>	<optional>	The compute resource available in virtual cores. The array has three entries: first, trusted app, second, untrusted within the incubation period, and third, untrusted and not in incubation.
`memory`	Array.<number>	<optional>	The memory resource available in megabytes. See `cpus` for the array description.
`storage`	Array.<number>	<optional>	The ephemeral storage in megabytes. See `cpus` for the array description.
`egress`	Array.<number>	<optional>	The maximum egress bandwith in megabytes per second. See `cpus` for the array description.

Type:

Object

statType

Source:

types.js, line 275

Properties:

Name	Type	Description
`id`	string	An identifier for the app
`tasksRunning`	number	The number of app processes running.
`props`	deploymentPropsType	The properties of the app.
`version`	string	An instance version for this app.

Type:

Object

updateOptionsType

Source:

types.js, line 218

Properties:

Name	Type	Description
`id`	string
`plan`	string	The strategy to flex resources.
`numberOfCAs`	number	The number of active CAs.
`currentProps`	deploymentPropsType	The deployment properties currently used.

Type:

Object