documentation.js

/*
Copyright 2020 DigitalOcean

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/* 	documentation:
	Documents all the possible prop types and metadata
	that can be associated with Nodes, Connectors, Diagrams
*/

export default {
	node: {
		name: {
			type:'string',
			validation:[1,40],
			title: 'Name',
			info:'The node name or hostname.'
		},
	    shortName: {
	    	type: 'string',
	    	validation: [0,15],
			title: 'Short Name',
	    	info: 'Optional shorter name (15 char max) of node to be displayed in diagrams.'
	    },
	    description: {
	    	type: 'string',
	    	length: [0,255],
			title: 'Description',
	    	info: 'Optional description of node, can use markdown, 255 char max.',
	    	markdown: true
	    },
    	state: {
	        type: 'string',
	        validation: ['planned', 'initializing', 'active', 'off'],
			title: 'State',
	        info: 'Node\'s current state, planned (default), initializing, active, off.',
	        default: 'planned'
	    },
	    agent: {
			type: 'boolean',
			title: 'Agent',
	        info: 'Should DigitalOcean monitoring agent be running on this node.',
	        default: true
	    },
	    algo: {
			type: 'string',
			title: 'Algorithm',
	        validation: ['round-robin', 'least-connections', 'sticky'],
	        info: 'Routing algorithm to be used when load-balancing connections.',
	        default: 'round-robin'
	    },
	    backups: {
			type: 'boolean',
			title: 'Backups',
	        info: 'Enable weekly backups for 20% increase on cost.',
	        default: true
	    },
	    categories: {
			type: 'array',
			title: 'Categories',
	    	info: 'server\'s categories',
	    },
	    cost: {
			type: 'number',
			title: 'Cost',
	        validation: [0,640],
	        info: 'Monthly cost of running this node.',
	        default: 5,
	        format: '$#'
	    },
	    size: {
			type: 'select',
			title: 'Size',
	        validation: ['s-1vcpu-1gb',  's-1vcpu-2gb', 's-1vcpu-3gb', 's-2vcpu-2gb', 's-3vcpu-1gb', 's-2vcpu-4gb', 'c-1vcpu-2gb',  'c-2', 's-4vcpu-8gb',  'c-4', 's-6vcpu-16gb', 'c-8', 's-8vcpu-32gb', 's-12vcpu-48gb', 'c-16', 's-16vcpu-64gb', 's-20vcpu-96gb', 'c-32', 's-24vcpu-128gb', 'c-46vcpu-92gb', 'c-48', 's-32vcpu-192gb'],
	        info: 'Droplet size',
	        default: 's-2vcpu-4gb',
	    },
	    image: {
			type: 'select',
			title: 'Image',
	        validation: ['Ubuntu 16.04.4 x64'],
	        info: 'Droplet image',
	        default: 'Ubuntu 16.04.4 x64',
	    },
	    userData: {
			type: 'string',
			title: 'User Data',
	    	info: 'commands to be run upon server creation.'
	    },
	    edge: {
			type: 'boolean',
			title: 'Edge',
	        info: 'Should node accept public (outside categoryal network) connections?',
	        default: false
	    },
	    privateNetwork: {
			type: 'boolean',
			title: 'Private Network',
	        info: 'Allow droplet to communicate on internal datacenter network.',
	        default: true
	    },
	    enableIpv6: {
			type: 'boolean',
			title: 'Enable IPv6',
	        info: 'Assign droplet an IPV6 address in addition to IPV4.',
	        default: true
	    },
	    id: {
			type: 'string',
			title: 'ID',
	        systemOnly: true,
	        info: 'DigitalOcean-assigned ID of node.'
	    },
	    publicIpv4: {
			type: 'string',
			title: 'Public IPv4',
	        validation: [7, 15],
	        systemOnly: true,
	        info: 'Public IPv4 address'
	    },
	    publicIpv6: {
	        type: 'string',
			title: 'Public IPv6',
	        validation: [7, 200],
	        systemOnly: true,
	        info: 'Public IPv6 address'
	    },
	    privateIpv4: {
	        type: 'string',
			title: 'Private IPv4',
	        validation: [7, 15],
	        systemOnly: true,
	        info: 'Private IPv4 address'
	    },
	    privateIpv6: {
	        type: 'string',
			title: 'Private IPv6',
	        validation: [7, 200],
	        systemOnly: true,
	        info: 'Private IPv6 address'
	    },
	    scale: {
	        type: 'number',
			title: 'Scale',
	        validation: [0.5,2],
	        info: 'Scales this node\'s appearance by 0.5 to 2.',
	        default: 1
	    },
	    tags: {
			type: 'string',
			title: 'Tags',
	        info: 'Comma-separated list of tags to apply to droplet.'
	    },
	    favicon: {
			type: 'url',
			title: 'Favicon',
	    	validation: [0,255],
	    	info: 'Optional link to a favicon to display on node.'
	    },
	    color: {
			type: 'color',
			title: 'Color',
	    	info: 'Optional accent color to use on node.'
	    },
	    cloudFirewall: {
			type: 'select',
			title: 'Cloud Firewall',
	        validation: ['disabled', 'tagBased', 'customized'],
	        info: 'Cloud firewall',
	        default: 'disabled'
	    },
	    blockStorage: {
			type: 'number',
			title: 'Block Storage',
	        validation: [0,16000],
	        info: 'Expandable SSD block storage.',
	        default: 100
	    },
	    managementMethod: {
			type: 'select',
			title: 'Management Method',
	        validation: ['web', 'doctl', 'terminal', 'terraform'],
	        info: 'How the infrastructure is deployed and managed',
	        default: 'terminal'
	    }
	},
	connector:{
		name: {
			type:'string',
			title: 'Name',
			validation:[1,40],
			info:'The node name or hostname.'
		},
	    description: {
			type: 'string',
			title: 'Description',
	    	length: [0,255],
	    	info: 'Optional description of node, can use markdown, 255 char max.',
	    	markdown: true
	    },
	    dns: {
			type: 'string',
			title: 'DNS',
			validation: [0,255],
			info: 'domain or subdomain'
		},
		encryption: {
			type: 'string',
			title: 'Encryption',
			validation: [0,255],
			info: 'type of encryption used (TLS,??)'
		},
		port: {
			type: 'number',
			title: 'Port',
			validation: [0,12000],
			info: 'port used for connection'
		},
	    color: {
			type: 'color',
			title: 'Color',
	    	info: 'Optional accent color to use on node.'
	    },
	    style: {
			type: 'select',
			title: 'Select',
	    	validation: ['curved', 'angular', 'square'],
	        info: 'Visual style of connector path',
	        default: 'curved'
	    }
	}
};