- modified 'site_nodes' view to only return nodes that aren't marked 'deleted'
[plcapi.git] / planetlab4.sql
1 --
2 -- PlanetLab Central database schema
3 -- Version 4, PostgreSQL
4 --
5 -- Aaron Klingaman <alk@cs.princeton.edu>
6 -- Reid Moran <rmoran@cs.princeton.edu>
7 -- Mark Huang <mlhuang@cs.princeton.edu>
8 -- Tony Mack <tmack@cs.princeton.edu>
9 --
10 -- Copyright (C) 2006 The Trustees of Princeton University
11 --
12 -- $Id: planetlab4.sql,v 1.79 2007/07/12 17:48:19 tmack Exp $
13 --
14
15 SET client_encoding = 'UNICODE';
16
17 --------------------------------------------------------------------------------
18 -- Aggregates and store procedures
19 --------------------------------------------------------------------------------
20
21 -- Like MySQL GROUP_CONCAT(), this function aggregates values into a
22 -- PostgreSQL array.
23 CREATE AGGREGATE array_accum (
24     sfunc = array_append,
25     basetype = anyelement,
26     stype = anyarray,
27     initcond = '{}'
28 );
29
30 --------------------------------------------------------------------------------
31 -- Version
32 --------------------------------------------------------------------------------
33
34 -- Database version
35 CREATE TABLE plc_db_version (
36     version integer NOT NULL,
37     subversion integer NOT NULL DEFAULT 0
38 ) WITH OIDS;
39
40 INSERT INTO plc_db_version (version, subversion) VALUES (4, 2);
41
42 --------------------------------------------------------------------------------
43 -- Accounts
44 --------------------------------------------------------------------------------
45
46 -- Accounts
47 CREATE TABLE persons (
48     -- Mandatory
49     person_id serial PRIMARY KEY, -- Account identifier
50     email text NOT NULL, -- E-mail address
51     first_name text NOT NULL, -- First name
52     last_name text NOT NULL, -- Last name
53     deleted boolean NOT NULL DEFAULT false, -- Has been deleted
54     enabled boolean NOT NULL DEFAULT false, -- Has been disabled
55
56     -- Password
57     password text NOT NULL DEFAULT 'nopass', -- Password (md5crypted)
58     verification_key text, -- Reset password key
59     verification_expires timestamp without time zone,
60
61     -- Optional
62     title text, -- Honorific
63     phone text, -- Telephone number
64     url text, -- Home page
65     bio text, -- Biography
66
67     -- Timestamps
68     date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
69     last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
70 ) WITH OIDS;
71 CREATE INDEX persons_email_idx ON persons (email) WHERE deleted IS false;
72
73 --------------------------------------------------------------------------------
74 -- Sites
75 --------------------------------------------------------------------------------
76
77 -- Sites
78 CREATE TABLE sites (
79     -- Mandatory
80     site_id serial PRIMARY KEY, -- Site identifier
81     login_base text NOT NULL, -- Site slice prefix
82     name text NOT NULL, -- Site name
83     abbreviated_name text NOT NULL, -- Site abbreviated name
84     enabled boolean NOT NULL Default true, -- Is this site enabled
85     deleted boolean NOT NULL DEFAULT false, -- Has been deleted
86     is_public boolean NOT NULL DEFAULT true, -- Shows up in public lists
87     max_slices integer NOT NULL DEFAULT 0, -- Maximum number of slices
88     max_slivers integer NOT NULL DEFAULT 1000, -- Maximum number of instantiated slivers
89
90     -- Optional
91     latitude real,
92     longitude real,
93     url text,
94     ext_consortium_id integer,  -- external consortium id
95
96     -- Timestamps
97     date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
98     last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
99 ) WITH OIDS;
100 CREATE INDEX sites_login_base_idx ON sites (login_base) WHERE deleted IS false;
101
102 -- Account site membership
103 CREATE TABLE person_site (
104     person_id integer REFERENCES persons NOT NULL, -- Account identifier
105     site_id integer REFERENCES sites NOT NULL, -- Site identifier
106     is_primary boolean NOT NULL DEFAULT false, -- Is the primary site for this account
107     PRIMARY KEY (person_id, site_id)
108 );
109 CREATE INDEX person_site_person_id_idx ON person_site (person_id);
110 CREATE INDEX person_site_site_id_idx ON person_site (site_id);
111
112 -- Ordered by primary site first
113 CREATE VIEW person_site_ordered AS
114 SELECT person_id, site_id
115 FROM person_site
116 ORDER BY is_primary DESC;
117
118 -- Sites that each person is a member of
119 CREATE VIEW person_sites AS
120 SELECT person_id,
121 array_accum(site_id) AS site_ids
122 FROM person_site_ordered
123 GROUP BY person_id;
124
125 -- Accounts at each site
126 CREATE VIEW site_persons AS
127 SELECT site_id,
128 array_accum(person_id) AS person_ids
129 FROM person_site
130 GROUP BY site_id;
131
132 --------------------------------------------------------------------------------
133 -- Mailing Addresses
134 --------------------------------------------------------------------------------
135
136 CREATE TABLE address_types (
137     address_type_id serial PRIMARY KEY, -- Address type identifier
138     name text UNIQUE NOT NULL, -- Address type
139     description text -- Address type description
140 ) WITH OIDS;
141
142 INSERT INTO address_types (name) VALUES ('Personal');
143 INSERT INTO address_types (name) VALUES ('Shipping');
144 -- XXX Used to be Site
145 INSERT INTO address_types (name) VALUES ('Billing');
146
147 -- Mailing addresses
148 CREATE TABLE addresses (
149     address_id serial PRIMARY KEY, -- Address identifier
150     line1 text NOT NULL, -- Address line 1
151     line2 text, -- Address line 2
152     line3 text, -- Address line 3
153     city text NOT NULL, -- City
154     state text NOT NULL, -- State or province
155     postalcode text NOT NULL, -- Postal code
156     country text NOT NULL -- Country
157 ) WITH OIDS;
158
159 -- Each mailing address can be one of several types
160 CREATE TABLE address_address_type (
161     address_id integer REFERENCES addresses NOT NULL, -- Address identifier
162     address_type_id integer REFERENCES address_types NOT NULL, -- Address type
163     PRIMARY KEY (address_id, address_type_id)
164 ) WITH OIDS;
165 CREATE INDEX address_address_type_address_id_idx ON address_address_type (address_id);
166 CREATE INDEX address_address_type_address_type_id_idx ON address_address_type (address_type_id);
167
168 CREATE VIEW address_address_types AS
169 SELECT address_id,
170 array_accum(address_type_id) AS address_type_ids,
171 array_accum(address_types.name) AS address_types
172 FROM address_address_type
173 LEFT JOIN address_types USING (address_type_id)
174 GROUP BY address_id;
175
176 CREATE TABLE site_address (
177     site_id integer REFERENCES sites NOT NULL, -- Site identifier
178     address_id integer REFERENCES addresses NOT NULL, -- Address identifier
179     PRIMARY KEY (site_id, address_id)
180 ) WITH OIDS;
181 CREATE INDEX site_address_site_id_idx ON site_address (site_id);
182 CREATE INDEX site_address_address_id_idx ON site_address (address_id);
183
184 CREATE VIEW site_addresses AS
185 SELECT site_id,
186 array_accum(address_id) AS address_ids
187 FROM site_address
188 GROUP BY site_id;
189
190 --------------------------------------------------------------------------------
191 -- Authentication Keys
192 --------------------------------------------------------------------------------
193
194 -- Valid key types
195 CREATE TABLE key_types (
196     key_type text PRIMARY KEY -- Key type
197 ) WITH OIDS;
198 INSERT INTO key_types (key_type) VALUES ('ssh');
199
200 -- Authentication keys
201 CREATE TABLE keys (
202     key_id serial PRIMARY KEY, -- Key identifier
203     key_type text REFERENCES key_types NOT NULL, -- Key type
204     key text NOT NULL, -- Key material
205     is_blacklisted boolean NOT NULL DEFAULT false -- Has been blacklisted
206 ) WITH OIDS;
207
208 -- Account authentication key(s)
209 CREATE TABLE person_key (
210     key_id integer REFERENCES keys PRIMARY KEY, -- Key identifier
211     person_id integer REFERENCES persons NOT NULL -- Account identifier
212 ) WITH OIDS;
213 CREATE INDEX person_key_person_id_idx ON person_key (person_id);
214
215 CREATE VIEW person_keys AS
216 SELECT person_id,
217 array_accum(key_id) AS key_ids
218 FROM person_key
219 GROUP BY person_id;
220
221 --------------------------------------------------------------------------------
222 -- Account roles
223 --------------------------------------------------------------------------------
224
225 -- Valid account roles
226 CREATE TABLE roles (
227     role_id integer PRIMARY KEY, -- Role identifier
228     name text UNIQUE NOT NULL -- Role symbolic name
229 ) WITH OIDS;
230 INSERT INTO roles (role_id, name) VALUES (10, 'admin');
231 INSERT INTO roles (role_id, name) VALUES (20, 'pi');
232 INSERT INTO roles (role_id, name) VALUES (30, 'user');
233 INSERT INTO roles (role_id, name) VALUES (40, 'tech');
234
235 CREATE TABLE person_role (
236     person_id integer REFERENCES persons NOT NULL, -- Account identifier
237     role_id integer REFERENCES roles NOT NULL, -- Role identifier
238     PRIMARY KEY (person_id, role_id)
239 ) WITH OIDS;
240 CREATE INDEX person_role_person_id_idx ON person_role (person_id);
241
242 -- Account roles
243 CREATE VIEW person_roles AS
244 SELECT person_id,
245 array_accum(role_id) AS role_ids,
246 array_accum(roles.name) AS roles
247 FROM person_role
248 LEFT JOIN roles USING (role_id)
249 GROUP BY person_id;
250
251 --------------------------------------------------------------------------------
252 -- Nodes
253 --------------------------------------------------------------------------------
254
255 -- Valid node boot states
256 CREATE TABLE boot_states (
257     boot_state text PRIMARY KEY
258 ) WITH OIDS;
259 INSERT INTO boot_states (boot_state) VALUES ('boot');
260 INSERT INTO boot_states (boot_state) VALUES ('dbg');
261 INSERT INTO boot_states (boot_state) VALUES ('inst');
262 INSERT INTO boot_states (boot_state) VALUES ('rins');
263 INSERT INTO boot_states (boot_state) VALUES ('rcnf');
264 INSERT INTO boot_states (boot_state) VALUES ('new');
265
266 -- Nodes
267 CREATE TABLE nodes (
268     -- Mandatory
269     node_id serial PRIMARY KEY, -- Node identifier
270     hostname text NOT NULL, -- Node hostname
271     site_id integer REFERENCES sites NOT NULL, -- At which site 
272
273     boot_state text REFERENCES boot_states NOT NULL DEFAULT 'inst', -- Node boot state
274     deleted boolean NOT NULL DEFAULT false, -- Is deleted
275
276     -- Optional
277     model text, -- Hardware make and model
278     boot_nonce text, -- Random nonce updated by Boot Manager
279     version text, -- Boot CD version string updated by Boot Manager
280     ssh_rsa_key text, -- SSH host key updated by Boot Manager
281     key text, -- Node key generated by API when configuration file is downloaded
282
283     -- Timestamps
284     date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
285     last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
286     last_contact timestamp without time zone    
287 ) WITH OIDS;
288 CREATE INDEX nodes_hostname_idx ON nodes (hostname) WHERE deleted IS false;
289 CREATE INDEX nodes_site_id_idx ON nodes (site_id) WHERE deleted IS false;
290
291 -- Nodes at each site
292 CREATE VIEW site_nodes AS
293 SELECT site_id,
294 array_accum(node_id) AS node_ids
295 FROM nodes
296 WHERE deleted IS false
297 GROUP BY site_id;
298
299 -- slice whitelist on nodes
300 CREATE TABLE node_slice_whitelist (
301     node_id integer REFERENCES nodes NOT NULL, -- Node id of whitelist
302     slice_id integer REFERENCES slices NOT NULL, -- Slice id thats allowd on this node
303     PRIMARY KEY (node_id, slice_id)
304 ) WITH OIDS;
305 CREATE INDEX node_slice_whitelist_node_id_idx ON node_slice_whitelist (node_id);
306 CREATE INDEX node_slice_whitelist_slice_id_idx ON node_slice_whitelist (slice_id);
307
308 -- Slices on each node
309 CREATE VIEW node_slices_whitelist AS
310 SELECT node_id, 
311 array_accum(slice_id) AS slice_ids_whitelist
312 FROM node_slice_whitelist
313 GROUP BY node_id;
314
315 --------------------------------------------------------------------------------
316 -- Node groups
317 --------------------------------------------------------------------------------
318
319 -- Node groups
320 CREATE TABLE nodegroups (
321     nodegroup_id serial PRIMARY KEY, -- Group identifier
322     name text UNIQUE NOT NULL, -- Group name
323     description text -- Group description
324 ) WITH OIDS;
325
326 -- Node group membership
327 CREATE TABLE nodegroup_node (
328     nodegroup_id integer REFERENCES nodegroups NOT NULL, -- Group identifier
329     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
330     PRIMARY KEY (nodegroup_id, node_id)
331 ) WITH OIDS;
332 CREATE INDEX nodegroup_node_nodegroup_id_idx ON nodegroup_node (nodegroup_id);
333 CREATE INDEX nodegroup_node_node_id_idx ON nodegroup_node (node_id);
334
335 -- Nodes in each node group
336 CREATE VIEW nodegroup_nodes AS
337 SELECT nodegroup_id,
338 array_accum(node_id) AS node_ids
339 FROM nodegroup_node
340 GROUP BY nodegroup_id;
341
342 -- Node groups that each node is a member of
343 CREATE VIEW node_nodegroups AS
344 SELECT node_id,
345 array_accum(nodegroup_id) AS nodegroup_ids
346 FROM nodegroup_node
347 GROUP BY node_id;
348
349 --------------------------------------------------------------------------------
350 -- Node configuration files
351 --------------------------------------------------------------------------------
352
353 CREATE TABLE conf_files (
354     conf_file_id serial PRIMARY KEY, -- Configuration file identifier
355     enabled bool NOT NULL DEFAULT true, -- Configuration file is active
356     source text NOT NULL, -- Relative path on the boot server where file can be downloaded
357     dest text NOT NULL, -- Absolute path where file should be installed
358     file_permissions text NOT NULL DEFAULT '0644', -- chmod(1) permissions
359     file_owner text NOT NULL DEFAULT 'root', -- chown(1) owner
360     file_group text NOT NULL DEFAULT 'root', -- chgrp(1) owner
361     preinstall_cmd text, -- Shell command to execute prior to installing
362     postinstall_cmd text, -- Shell command to execute after installing
363     error_cmd text, -- Shell command to execute if any error occurs
364     ignore_cmd_errors bool NOT NULL DEFAULT false, -- Install file anyway even if an error occurs
365     always_update bool NOT NULL DEFAULT false -- Always attempt to install file even if unchanged
366 );
367
368 CREATE TABLE conf_file_node (
369     conf_file_id integer REFERENCES conf_files NOT NULL, -- Configuration file identifier
370     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
371     PRIMARY KEY (conf_file_id, node_id)
372 );
373 CREATE INDEX conf_file_node_conf_file_id_idx ON conf_file_node (conf_file_id);
374 CREATE INDEX conf_file_node_node_id_idx ON conf_file_node (node_id);
375
376 -- Nodes linked to each configuration file
377 CREATE VIEW conf_file_nodes AS
378 SELECT conf_file_id,
379 array_accum(node_id) AS node_ids
380 FROM conf_file_node
381 GROUP BY conf_file_id;
382
383 -- Configuration files linked to each node
384 CREATE VIEW node_conf_files AS
385 SELECT node_id,
386 array_accum(conf_file_id) AS conf_file_ids
387 FROM conf_file_node
388 GROUP BY node_id;
389
390 CREATE TABLE conf_file_nodegroup (
391     conf_file_id integer REFERENCES conf_files NOT NULL, -- Configuration file identifier
392     nodegroup_id integer REFERENCES nodegroups NOT NULL, -- Node group identifier
393     PRIMARY KEY (conf_file_id, nodegroup_id)
394 );
395 CREATE INDEX conf_file_nodegroup_conf_file_id_idx ON conf_file_nodegroup (conf_file_id);
396 CREATE INDEX conf_file_nodegroup_nodegroup_id_idx ON conf_file_nodegroup (nodegroup_id);
397
398 -- Node groups linked to each configuration file
399 CREATE VIEW conf_file_nodegroups AS
400 SELECT conf_file_id,
401 array_accum(nodegroup_id) AS nodegroup_ids
402 FROM conf_file_nodegroup
403 GROUP BY conf_file_id;
404
405 -- Configuration files linked to each node group
406 CREATE VIEW nodegroup_conf_files AS
407 SELECT nodegroup_id,
408 array_accum(conf_file_id) AS conf_file_ids
409 FROM conf_file_nodegroup
410 GROUP BY nodegroup_id;
411
412 --------------------------------------------------------------------------------
413 -- Node network interfaces
414 --------------------------------------------------------------------------------
415
416 -- Valid network addressing schemes
417 CREATE TABLE network_types (
418     type text PRIMARY KEY -- Addressing scheme
419 ) WITH OIDS;
420 INSERT INTO network_types (type) VALUES ('ipv4');
421
422 -- Valid network configuration methods
423 CREATE TABLE network_methods (
424     method text PRIMARY KEY -- Configuration method
425 ) WITH OIDS;
426 INSERT INTO network_methods (method) VALUES ('static');
427 INSERT INTO network_methods (method) VALUES ('dhcp');
428 INSERT INTO network_methods (method) VALUES ('proxy');
429 INSERT INTO network_methods (method) VALUES ('tap');
430 INSERT INTO network_methods (method) VALUES ('ipmi');
431 INSERT INTO network_methods (method) VALUES ('unknown');
432
433 -- Node network interfaces
434 CREATE TABLE nodenetworks (
435     -- Mandatory
436     nodenetwork_id serial PRIMARY KEY, -- Network interface identifier
437     node_id integer REFERENCES nodes NOT NULL, -- Which node
438     is_primary boolean NOT NULL DEFAULT false, -- Is the primary interface for this node
439     type text REFERENCES network_types NOT NULL, -- Addressing scheme
440     method text REFERENCES network_methods NOT NULL, -- Configuration method
441
442     -- Optional, depending on type and method
443     ip text, -- IP address
444     mac text, -- MAC address
445     gateway text, -- Default gateway address
446     network text, -- Network address
447     broadcast text, -- Network broadcast address
448     netmask text, -- Network mask
449     dns1 text, -- Primary DNS server
450     dns2 text, -- Secondary DNS server
451     bwlimit integer, -- Bandwidth limit in bps
452     hostname text -- Hostname of this interface
453 ) WITH OIDS;
454 CREATE INDEX nodenetworks_node_id_idx ON nodenetworks (node_id);
455
456 -- Ordered by primary interface first
457 CREATE VIEW nodenetworks_ordered AS
458 SELECT node_id, nodenetwork_id
459 FROM nodenetworks
460 ORDER BY is_primary DESC;
461
462 -- Network interfaces on each node
463 CREATE VIEW node_nodenetworks AS
464 SELECT node_id,
465 array_accum(nodenetwork_id) AS nodenetwork_ids
466 FROM nodenetworks_ordered
467 GROUP BY node_id;
468
469 --------------------------------------------------------------------------------
470 -- Power control units (PCUs)
471 --------------------------------------------------------------------------------
472
473 CREATE TABLE pcus (
474     -- Mandatory
475     pcu_id serial PRIMARY KEY, -- PCU identifier
476     site_id integer REFERENCES sites NOT NULL, -- Site identifier
477     hostname text, -- Hostname, not necessarily unique (multiple logical sites could use the same PCU)
478     ip text NOT NULL, -- IP, not necessarily unique
479
480     -- Optional
481     protocol text, -- Protocol, e.g. ssh or https or telnet
482     username text, -- Username, if applicable
483     "password" text, -- Password, if applicable
484     model text, -- Model, e.g. BayTech or iPal
485     notes text -- Random notes
486 ) WITH OIDS;
487 CREATE INDEX pcus_site_id_idx ON pcus (site_id);
488
489 CREATE VIEW site_pcus AS
490 SELECT site_id,
491 array_accum(pcu_id) AS pcu_ids
492 FROM pcus
493 GROUP BY site_id;
494
495 CREATE TABLE pcu_node (
496     pcu_id integer REFERENCES pcus NOT NULL, -- PCU identifier
497     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
498     port integer NOT NULL, -- Port number
499     PRIMARY KEY (pcu_id, node_id), -- The same node cannot be controlled by different ports
500     UNIQUE (pcu_id, port) -- The same port cannot control multiple nodes
501 );
502 CREATE INDEX pcu_node_pcu_id_idx ON pcu_node (pcu_id);
503 CREATE INDEX pcu_node_node_id_idx ON pcu_node (node_id);
504
505 CREATE VIEW node_pcus AS
506 SELECT node_id,
507 array_accum(pcu_id) AS pcu_ids,
508 array_accum(port) AS ports
509 FROM pcu_node
510 GROUP BY node_id;
511
512 CREATE VIEW pcu_nodes AS
513 SELECT pcu_id,
514 array_accum(node_id) AS node_ids,
515 array_accum(port) AS ports
516 FROM pcu_node
517 GROUP BY pcu_id;
518
519 --------------------------------------------------------------------------------
520 -- Slices
521 --------------------------------------------------------------------------------
522
523 CREATE TABLE slice_instantiations (
524     instantiation text PRIMARY KEY
525 ) WITH OIDS;
526 INSERT INTO slice_instantiations (instantiation) VALUES ('not-instantiated'); -- Placeholder slice
527 INSERT INTO slice_instantiations (instantiation) VALUES ('plc-instantiated'); -- Instantiated by Node Manager
528 INSERT INTO slice_instantiations (instantiation) VALUES ('delegated'); -- Manually instantiated
529 INSERT INTO slice_instantiations (instantiation) VALUES ('nm-controller'); -- NM Controller
530
531 -- Slices
532 CREATE TABLE slices (
533     slice_id serial PRIMARY KEY, -- Slice identifier
534     site_id integer REFERENCES sites NOT NULL, -- Site identifier
535
536     name text NOT NULL, -- Slice name
537     instantiation text REFERENCES slice_instantiations NOT NULL DEFAULT 'plc-instantiated', -- Slice state, e.g. plc-instantiated
538     url text, -- Project URL
539     description text, -- Project description
540
541     max_nodes integer NOT NULL DEFAULT 100, -- Maximum number of nodes that can be assigned to this slice
542
543     creator_person_id integer REFERENCES persons, -- Creator
544     created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Creation date
545     expires timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP + '2 weeks', -- Expiration date
546
547     is_deleted boolean NOT NULL DEFAULT false
548 ) WITH OIDS;
549 CREATE INDEX slices_site_id_idx ON slices (site_id) WHERE is_deleted IS false;
550 CREATE INDEX slices_name_idx ON slices (name) WHERE is_deleted IS false;
551
552 -- Slivers
553 CREATE TABLE slice_node (
554     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
555     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
556     PRIMARY KEY (slice_id, node_id)
557 ) WITH OIDS;
558 CREATE INDEX slice_node_slice_id_idx ON slice_node (slice_id);
559 CREATE INDEX slice_node_node_id_idx ON slice_node (node_id);
560
561 -- Synonym for slice_node
562 CREATE VIEW slivers AS
563 SELECT * FROM slice_node;
564
565 -- Nodes in each slice
566 CREATE VIEW slice_nodes AS
567 SELECT slice_id,
568 array_accum(node_id) AS node_ids
569 FROM slice_node
570 GROUP BY slice_id;
571
572 -- Slices on each node
573 CREATE VIEW node_slices AS
574 SELECT node_id,
575 array_accum(slice_id) AS slice_ids
576 FROM slice_node
577 GROUP BY node_id;
578
579 -- Slices at each site
580 CREATE VIEW site_slices AS
581 SELECT site_id,
582 array_accum(slice_id) AS slice_ids
583 FROM slices
584 WHERE is_deleted is false
585 GROUP BY site_id;
586
587 -- Slice membership
588 CREATE TABLE slice_person (
589     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
590     person_id integer REFERENCES persons NOT NULL, -- Account identifier
591     PRIMARY KEY (slice_id, person_id)
592 ) WITH OIDS;
593 CREATE INDEX slice_person_slice_id_idx ON slice_person (slice_id);
594 CREATE INDEX slice_person_person_id_idx ON slice_person (person_id);
595
596 -- Members of the slice
597 CREATE VIEW slice_persons AS
598 SELECT slice_id,
599 array_accum(person_id) AS person_ids
600 FROM slice_person
601 GROUP BY slice_id;
602
603 -- Slices of which each person is a member
604 CREATE VIEW person_slices AS
605 SELECT person_id,
606 array_accum(slice_id) AS slice_ids
607 FROM slice_person
608 GROUP BY person_id;
609
610 --------------------------------------------------------------------------------
611 -- Slice attributes
612 --------------------------------------------------------------------------------
613
614 -- Slice attribute types
615 CREATE TABLE slice_attribute_types (
616     attribute_type_id serial PRIMARY KEY, -- Attribute type identifier
617     name text UNIQUE NOT NULL, -- Attribute name
618     description text, -- Attribute description
619     min_role_id integer REFERENCES roles DEFAULT 10 -- If set, minimum (least powerful) role that can set or change this attribute
620 ) WITH OIDS;
621
622 -- Slice/sliver attributes
623 CREATE TABLE slice_attribute (
624     slice_attribute_id serial PRIMARY KEY, -- Slice attribute identifier
625     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
626     node_id integer REFERENCES nodes, -- Sliver attribute if set
627     nodegroup_id integer REFERENCES nodegroups, -- Node group attribute if set
628     attribute_type_id integer REFERENCES slice_attribute_types NOT NULL, -- Attribute type identifier
629     value text
630 ) WITH OIDS;
631 CREATE INDEX slice_attribute_slice_id_idx ON slice_attribute (slice_id);
632 CREATE INDEX slice_attribute_node_id_idx ON slice_attribute (node_id);
633 CREATE INDEX slice_attribute_nodegroup_id_idx ON slice_attribute (nodegroup_id);
634
635 CREATE VIEW slice_attributes AS
636 SELECT slice_id,
637 array_accum(slice_attribute_id) AS slice_attribute_ids
638 FROM slice_attribute
639 GROUP BY slice_id;
640
641 --------------------------------------------------------------------------------
642 -- Initscripts
643 --------------------------------------------------------------------------------
644
645 -- Initscripts
646 CREATE TABLE initscripts (
647     initscript_id serial PRIMARY KEY, -- Initscript identifier
648     name text NOT NULL, -- Initscript name
649     enabled bool NOT NULL DEFAULT true, -- Initscript is active
650     script text NOT NULL, -- Initscript
651     UNIQUE (name)
652 ) WITH OIDS;
653 CREATE INDEX initscripts_name_idx ON initscripts (name);
654
655
656 --------------------------------------------------------------------------------
657 -- Peers
658 --------------------------------------------------------------------------------
659
660 -- Peers
661 CREATE TABLE peers (
662     peer_id serial PRIMARY KEY, -- Peer identifier
663     peername text NOT NULL, -- Peer name
664     peer_url text NOT NULL, -- (HTTPS) URL of the peer PLCAPI interface
665     cacert text, -- (SSL) Public certificate of peer API server
666     key text, -- (GPG) Public key used for authentication
667     deleted boolean NOT NULL DEFAULT false
668 ) WITH OIDS;
669 CREATE INDEX peers_peername_idx ON peers (peername) WHERE deleted IS false;
670
671 -- Objects at each peer
672 CREATE TABLE peer_site (
673     site_id integer REFERENCES sites PRIMARY KEY, -- Local site identifier
674     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
675     peer_site_id integer NOT NULL, -- Foreign site identifier at peer
676     UNIQUE (peer_id, peer_site_id) -- The same foreign site should not be cached twice
677 ) WITH OIDS;
678 CREATE INDEX peer_site_peer_id_idx ON peers (peer_id);
679
680 CREATE VIEW peer_sites AS
681 SELECT peer_id,
682 array_accum(site_id) AS site_ids,
683 array_accum(peer_site_id) AS peer_site_ids
684 FROM peer_site
685 GROUP BY peer_id;
686
687 CREATE TABLE peer_person (
688     person_id integer REFERENCES persons PRIMARY KEY, -- Local user identifier
689     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
690     peer_person_id integer NOT NULL, -- Foreign user identifier at peer
691     UNIQUE (peer_id, peer_person_id) -- The same foreign user should not be cached twice
692 ) WITH OIDS;
693 CREATE INDEX peer_person_peer_id_idx ON peer_person (peer_id);
694
695 CREATE VIEW peer_persons AS
696 SELECT peer_id,
697 array_accum(person_id) AS person_ids,
698 array_accum(peer_person_id) AS peer_person_ids
699 FROM peer_person
700 GROUP BY peer_id;
701
702 CREATE TABLE peer_key (
703     key_id integer REFERENCES keys PRIMARY KEY, -- Local key identifier
704     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
705     peer_key_id integer NOT NULL, -- Foreign key identifier at peer
706     UNIQUE (peer_id, peer_key_id) -- The same foreign key should not be cached twice
707 ) WITH OIDS;
708 CREATE INDEX peer_key_peer_id_idx ON peer_key (peer_id);
709
710 CREATE VIEW peer_keys AS
711 SELECT peer_id,
712 array_accum(key_id) AS key_ids,
713 array_accum(peer_key_id) AS peer_key_ids
714 FROM peer_key
715 GROUP BY peer_id;
716
717 CREATE TABLE peer_node (
718     node_id integer REFERENCES nodes PRIMARY KEY, -- Local node identifier
719     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
720     peer_node_id integer NOT NULL, -- Foreign node identifier
721     UNIQUE (peer_id, peer_node_id) -- The same foreign node should not be cached twice
722 ) WITH OIDS;
723 CREATE INDEX peer_node_peer_id_idx ON peer_node (peer_id);
724
725 CREATE VIEW peer_nodes AS
726 SELECT peer_id,
727 array_accum(node_id) AS node_ids,
728 array_accum(peer_node_id) AS peer_node_ids
729 FROM peer_node
730 GROUP BY peer_id;
731
732 CREATE TABLE peer_slice (
733     slice_id integer REFERENCES slices PRIMARY KEY, -- Local slice identifier
734     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
735     peer_slice_id integer NOT NULL, -- Slice identifier at peer
736     UNIQUE (peer_id, peer_slice_id) -- The same foreign slice should not be cached twice
737 ) WITH OIDS;
738 CREATE INDEX peer_slice_peer_id_idx ON peer_slice (peer_id);
739
740 CREATE VIEW peer_slices AS
741 SELECT peer_id,
742 array_accum(slice_id) AS slice_ids,
743 array_accum(peer_slice_id) AS peer_slice_ids
744 FROM peer_slice
745 GROUP BY peer_id;
746
747 --------------------------------------------------------------------------------
748 -- Authenticated sessions
749 --------------------------------------------------------------------------------
750
751 -- Authenticated sessions
752 CREATE TABLE sessions (
753     session_id text PRIMARY KEY, -- Session identifier
754     expires timestamp without time zone
755 ) WITH OIDS;
756
757 -- People can have multiple sessions
758 CREATE TABLE person_session (
759     person_id integer REFERENCES persons NOT NULL, -- Account identifier
760     session_id text REFERENCES sessions NOT NULL, -- Session identifier
761     PRIMARY KEY (person_id, session_id),
762     UNIQUE (session_id) -- Sessions are unique
763 ) WITH OIDS;
764 CREATE INDEX person_session_person_id_idx ON person_session (person_id);
765
766 -- Nodes can have only one session
767 CREATE TABLE node_session (
768     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
769     session_id text REFERENCES sessions NOT NULL, -- Session identifier
770     UNIQUE (node_id), -- Nodes can have only one session
771     UNIQUE (session_id) -- Sessions are unique
772 ) WITH OIDS;
773
774 --------------------------------------------------------------------------------
775 -- Message templates
776 --------------------------------------------------------------------------------
777
778 CREATE TABLE messages (
779     message_id text PRIMARY KEY, -- Message name
780     subject text, -- Message summary
781     template text, -- Message template
782     enabled bool NOT NULL DEFAULT true -- Whether message is enabled
783 ) WITH OIDS;
784
785 --------------------------------------------------------------------------------
786 -- Events
787 --------------------------------------------------------------------------------
788
789 -- Events
790 CREATE TABLE events (
791     event_id serial PRIMARY KEY,  -- Event identifier
792     person_id integer REFERENCES persons, -- Person responsible for event, if any
793     node_id integer REFERENCES nodes, -- Node responsible for event, if any
794     auth_type text, -- Type of auth used. i.e. AuthMethod
795     fault_code integer NOT NULL DEFAULT 0, -- Did this event result in error
796     call_name text NOT NULL, -- Call responsible for this event
797     call text NOT NULL, -- Call responsible for this event, including parameters
798     message text, -- High level description of this event
799     runtime float DEFAULT 0, -- Event run time
800     time timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP -- Event timestamp
801 ) WITH OIDS;
802
803 -- Database object(s) that may have been affected by a particular event
804 CREATE TABLE event_object (
805     event_id integer REFERENCES events NOT NULL, -- Event identifier
806     object_id integer NOT NULL, -- Object identifier
807     object_type text NOT NULL Default 'Unknown' -- What type of object is this event affecting
808 ) WITH OIDS;
809 CREATE INDEX event_object_event_id_idx ON event_object (event_id);
810 CREATE INDEX event_object_object_id_idx ON event_object (object_id);
811 CREATE INDEX event_object_object_type_idx ON event_object (object_type);
812
813 CREATE VIEW event_objects AS
814 SELECT event_id,
815 array_accum(object_id) AS object_ids,
816 array_accum(object_type) AS object_types
817 FROM event_object
818 GROUP BY event_id;
819
820 --------------------------------------------------------------------------------
821 -- Useful views
822 --------------------------------------------------------------------------------
823
824 CREATE OR REPLACE VIEW view_events AS
825 SELECT
826 events.event_id,
827 events.person_id,
828 events.node_id,
829 events.auth_type,
830 events.fault_code,
831 events.call_name,
832 events.call,
833 events.message,
834 events.runtime,
835 CAST(date_part('epoch', events.time) AS bigint) AS time,
836 COALESCE((SELECT object_ids FROM event_objects WHERE event_objects.event_id = events.event_id), '{}') AS object_ids,
837 COALESCE((SELECT object_types FROM event_objects WHERE event_objects.event_id = events.event_id), '{}') AS object_types
838 FROM events;
839
840 CREATE OR REPLACE VIEW view_persons AS
841 SELECT
842 persons.person_id,
843 persons.email,
844 persons.first_name,
845 persons.last_name,
846 persons.deleted,
847 persons.enabled,
848 persons.password,
849 persons.verification_key,
850 CAST(date_part('epoch', persons.verification_expires) AS bigint) AS verification_expires,
851 persons.title,
852 persons.phone,
853 persons.url,
854 persons.bio,
855 CAST(date_part('epoch', persons.date_created) AS bigint) AS date_created,
856 CAST(date_part('epoch', persons.last_updated) AS bigint) AS last_updated,
857 peer_person.peer_id,
858 peer_person.peer_person_id,
859 COALESCE((SELECT role_ids FROM person_roles WHERE person_roles.person_id = persons.person_id), '{}') AS role_ids,
860 COALESCE((SELECT roles FROM person_roles WHERE person_roles.person_id = persons.person_id), '{}') AS roles,
861 COALESCE((SELECT site_ids FROM person_sites WHERE person_sites.person_id = persons.person_id), '{}') AS site_ids,
862 COALESCE((SELECT key_ids FROM person_keys WHERE person_keys.person_id = persons.person_id), '{}') AS key_ids,
863 COALESCE((SELECT slice_ids FROM person_slices WHERE person_slices.person_id = persons.person_id), '{}') AS slice_ids
864 FROM persons
865 LEFT JOIN peer_person USING (person_id);
866
867 CREATE OR REPLACE VIEW view_peers AS
868 SELECT 
869 peers.*, 
870 COALESCE((SELECT site_ids FROM peer_sites WHERE peer_sites.peer_id = peers.peer_id), '{}') AS site_ids,
871 COALESCE((SELECT peer_site_ids FROM peer_sites WHERE peer_sites.peer_id = peers.peer_id), '{}') AS peer_site_ids,
872 COALESCE((SELECT person_ids FROM peer_persons WHERE peer_persons.peer_id = peers.peer_id), '{}') AS person_ids,
873 COALESCE((SELECT peer_person_ids FROM peer_persons WHERE peer_persons.peer_id = peers.peer_id), '{}') AS peer_person_ids,
874 COALESCE((SELECT key_ids FROM peer_keys WHERE peer_keys.peer_id = peers.peer_id), '{}') AS key_ids,
875 COALESCE((SELECT peer_key_ids FROM peer_keys WHERE peer_keys.peer_id = peers.peer_id), '{}') AS peer_key_ids,
876 COALESCE((SELECT node_ids FROM peer_nodes WHERE peer_nodes.peer_id = peers.peer_id), '{}') AS node_ids,
877 COALESCE((SELECT peer_node_ids FROM peer_nodes WHERE peer_nodes.peer_id = peers.peer_id), '{}') AS peer_node_ids,
878 COALESCE((SELECT slice_ids FROM peer_slices WHERE peer_slices.peer_id = peers.peer_id), '{}') AS slice_ids,
879 COALESCE((SELECT peer_slice_ids FROM peer_slices WHERE peer_slices.peer_id = peers.peer_id), '{}') AS peer_slice_ids
880 FROM peers;
881
882 CREATE OR REPLACE VIEW view_nodes AS
883 SELECT
884 nodes.node_id,
885 nodes.hostname,
886 nodes.site_id,
887 nodes.boot_state,
888 nodes.deleted,
889 nodes.model,
890 nodes.boot_nonce,
891 nodes.version,
892 nodes.ssh_rsa_key,
893 nodes.key,
894 CAST(date_part('epoch', nodes.date_created) AS bigint) AS date_created,
895 CAST(date_part('epoch', nodes.last_updated) AS bigint) AS last_updated,
896 CAST(date_part('epoch', nodes.last_contact) AS bigint) AS last_contact,  
897 peer_node.peer_id,
898 peer_node.peer_node_id,
899 COALESCE((SELECT nodenetwork_ids FROM node_nodenetworks WHERE node_nodenetworks.node_id = nodes.node_id), '{}') AS nodenetwork_ids,
900 COALESCE((SELECT nodegroup_ids FROM node_nodegroups WHERE node_nodegroups.node_id = nodes.node_id), '{}') AS nodegroup_ids,
901 COALESCE((SELECT slice_ids FROM node_slices WHERE node_slices.node_id = nodes.node_id), '{}') AS slice_ids,
902 COALESCE((SELECT slice_ids_whitelist FROM node_slices_whitelist WHERE node_slices_whitelist.node_id = nodes.node_id), '{}') AS slice_ids_whitelist,
903 COALESCE((SELECT pcu_ids FROM node_pcus WHERE node_pcus.node_id = nodes.node_id), '{}') AS pcu_ids,
904 COALESCE((SELECT ports FROM node_pcus WHERE node_pcus.node_id = nodes.node_id), '{}') AS ports,
905 COALESCE((SELECT conf_file_ids FROM node_conf_files WHERE node_conf_files.node_id = nodes.node_id), '{}') AS conf_file_ids,
906 node_session.session_id AS session
907 FROM nodes
908 LEFT JOIN peer_node USING (node_id)
909 LEFT JOIN node_session USING (node_id);
910
911 CREATE OR REPLACE VIEW view_nodegroups AS
912 SELECT
913 nodegroups.*,
914 COALESCE((SELECT node_ids FROM nodegroup_nodes WHERE nodegroup_nodes.nodegroup_id = nodegroups.nodegroup_id), '{}') AS node_ids,
915 COALESCE((SELECT conf_file_ids FROM nodegroup_conf_files WHERE nodegroup_conf_files.nodegroup_id = nodegroups.nodegroup_id), '{}') AS conf_file_ids
916 FROM nodegroups;
917
918 CREATE OR REPLACE VIEW view_conf_files AS
919 SELECT
920 conf_files.*,
921 COALESCE((SELECT node_ids FROM conf_file_nodes WHERE conf_file_nodes.conf_file_id = conf_files.conf_file_id), '{}') AS node_ids,
922 COALESCE((SELECT nodegroup_ids FROM conf_file_nodegroups WHERE conf_file_nodegroups.conf_file_id = conf_files.conf_file_id), '{}') AS nodegroup_ids
923 FROM conf_files;
924
925 CREATE OR REPLACE VIEW view_pcus AS
926 SELECT
927 pcus.*,
928 COALESCE((SELECT node_ids FROM pcu_nodes WHERE pcu_nodes.pcu_id = pcus.pcu_id), '{}') AS node_ids,
929 COALESCE((SELECT ports FROM pcu_nodes WHERE pcu_nodes.pcu_id = pcus.pcu_id), '{}') AS ports
930 FROM pcus;
931
932 CREATE OR REPLACE VIEW view_sites AS
933 SELECT
934 sites.site_id,
935 sites.login_base,
936 sites.name,
937 sites.abbreviated_name,
938 sites.deleted,
939 sites.enabled,
940 sites.is_public,
941 sites.max_slices,
942 sites.max_slivers,
943 sites.latitude,
944 sites.longitude,
945 sites.url,
946 sites.ext_consortium_id,
947 CAST(date_part('epoch', sites.date_created) AS bigint) AS date_created,
948 CAST(date_part('epoch', sites.last_updated) AS bigint) AS last_updated,
949 peer_site.peer_id,
950 peer_site.peer_site_id,
951 COALESCE((SELECT person_ids FROM site_persons WHERE site_persons.site_id = sites.site_id), '{}') AS person_ids,
952 COALESCE((SELECT node_ids FROM site_nodes WHERE site_nodes.site_id = sites.site_id), '{}') AS node_ids,
953 COALESCE((SELECT address_ids FROM site_addresses WHERE site_addresses.site_id = sites.site_id), '{}') AS address_ids,
954 COALESCE((SELECT slice_ids FROM site_slices WHERE site_slices.site_id = sites.site_id), '{}') AS slice_ids,
955 COALESCE((SELECT pcu_ids FROM site_pcus WHERE site_pcus.site_id = sites.site_id), '{}') AS pcu_ids
956 FROM sites
957 LEFT JOIN peer_site USING (site_id);
958
959 CREATE OR REPLACE VIEW view_addresses AS
960 SELECT
961 addresses.*,
962 COALESCE((SELECT address_type_ids FROM address_address_types WHERE address_address_types.address_id = addresses.address_id), '{}') AS address_type_ids,
963 COALESCE((SELECT address_types FROM address_address_types WHERE address_address_types.address_id = addresses.address_id), '{}') AS address_types
964 FROM addresses;
965
966 CREATE OR REPLACE VIEW view_keys AS
967 SELECT
968 keys.*,
969 person_key.person_id,
970 peer_key.peer_id,
971 peer_key.peer_key_id
972 FROM keys
973 LEFT JOIN person_key USING (key_id)
974 LEFT JOIN peer_key USING (key_id);
975
976 CREATE OR REPLACE VIEW view_slices AS
977 SELECT
978 slices.slice_id,
979 slices.site_id,
980 slices.name,
981 slices.instantiation,
982 slices.url,
983 slices.description,
984 slices.max_nodes,
985 slices.creator_person_id,
986 slices.is_deleted,
987 CAST(date_part('epoch', slices.created) AS bigint) AS created,
988 CAST(date_part('epoch', slices.expires) AS bigint) AS expires,
989 peer_slice.peer_id,
990 peer_slice.peer_slice_id,
991 COALESCE((SELECT node_ids FROM slice_nodes WHERE slice_nodes.slice_id = slices.slice_id), '{}') AS node_ids,
992 COALESCE((SELECT person_ids FROM slice_persons WHERE slice_persons.slice_id = slices.slice_id), '{}') AS person_ids,
993 COALESCE((SELECT slice_attribute_ids FROM slice_attributes WHERE slice_attributes.slice_id = slices.slice_id), '{}') AS slice_attribute_ids
994 FROM slices
995 LEFT JOIN peer_slice USING (slice_id);
996
997 CREATE OR REPLACE VIEW view_slice_attributes AS
998 SELECT
999 slice_attribute.slice_attribute_id,
1000 slice_attribute.slice_id,
1001 slice_attribute.node_id,
1002 slice_attribute.nodegroup_id,
1003 slice_attribute_types.attribute_type_id,
1004 slice_attribute_types.name,
1005 slice_attribute_types.description,
1006 slice_attribute_types.min_role_id,
1007 slice_attribute.value
1008 FROM slice_attribute
1009 INNER JOIN slice_attribute_types USING (attribute_type_id);
1010
1011 CREATE OR REPLACE VIEW view_sessions AS
1012 SELECT
1013 sessions.session_id,
1014 CAST(date_part('epoch', sessions.expires) AS bigint) AS expires,
1015 person_session.person_id,
1016 node_session.node_id
1017 FROM sessions
1018 LEFT JOIN person_session USING (session_id)
1019 LEFT JOIN node_session USING (session_id);
1020
1021 --------------------------------------------------------------------------------
1022 -- Built-in maintenance account and default site
1023 --------------------------------------------------------------------------------
1024
1025 INSERT INTO persons
1026 (first_name, last_name, email, password, enabled)
1027 VALUES
1028 ('Maintenance', 'Account', 'maint@localhost.localdomain', 'nopass', true);
1029
1030 INSERT INTO person_role (person_id, role_id) VALUES (1, 10);
1031 INSERT INTO person_role (person_id, role_id) VALUES (1, 20);
1032 INSERT INTO person_role (person_id, role_id) VALUES (1, 30);
1033 INSERT INTO person_role (person_id, role_id) VALUES (1, 40);
1034
1035 INSERT INTO sites
1036 (login_base, name, abbreviated_name, max_slices)
1037 VALUES
1038 ('pl', 'PlanetLab Central', 'PLC', 100);