merge changes from HEAD
[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.81 2007/08/08 19:50:40 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 --------------------------------------------------------------------------------
300 -- Node groups
301 --------------------------------------------------------------------------------
302
303 -- Node groups
304 CREATE TABLE nodegroups (
305     nodegroup_id serial PRIMARY KEY, -- Group identifier
306     name text UNIQUE NOT NULL, -- Group name
307     description text -- Group description
308 ) WITH OIDS;
309
310 -- Node group membership
311 CREATE TABLE nodegroup_node (
312     nodegroup_id integer REFERENCES nodegroups NOT NULL, -- Group identifier
313     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
314     PRIMARY KEY (nodegroup_id, node_id)
315 ) WITH OIDS;
316 CREATE INDEX nodegroup_node_nodegroup_id_idx ON nodegroup_node (nodegroup_id);
317 CREATE INDEX nodegroup_node_node_id_idx ON nodegroup_node (node_id);
318
319 -- Nodes in each node group
320 CREATE VIEW nodegroup_nodes AS
321 SELECT nodegroup_id,
322 array_accum(node_id) AS node_ids
323 FROM nodegroup_node
324 GROUP BY nodegroup_id;
325
326 -- Node groups that each node is a member of
327 CREATE VIEW node_nodegroups AS
328 SELECT node_id,
329 array_accum(nodegroup_id) AS nodegroup_ids
330 FROM nodegroup_node
331 GROUP BY node_id;
332
333 --------------------------------------------------------------------------------
334 -- Node configuration files
335 --------------------------------------------------------------------------------
336
337 CREATE TABLE conf_files (
338     conf_file_id serial PRIMARY KEY, -- Configuration file identifier
339     enabled bool NOT NULL DEFAULT true, -- Configuration file is active
340     source text NOT NULL, -- Relative path on the boot server where file can be downloaded
341     dest text NOT NULL, -- Absolute path where file should be installed
342     file_permissions text NOT NULL DEFAULT '0644', -- chmod(1) permissions
343     file_owner text NOT NULL DEFAULT 'root', -- chown(1) owner
344     file_group text NOT NULL DEFAULT 'root', -- chgrp(1) owner
345     preinstall_cmd text, -- Shell command to execute prior to installing
346     postinstall_cmd text, -- Shell command to execute after installing
347     error_cmd text, -- Shell command to execute if any error occurs
348     ignore_cmd_errors bool NOT NULL DEFAULT false, -- Install file anyway even if an error occurs
349     always_update bool NOT NULL DEFAULT false -- Always attempt to install file even if unchanged
350 );
351
352 CREATE TABLE conf_file_node (
353     conf_file_id integer REFERENCES conf_files NOT NULL, -- Configuration file identifier
354     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
355     PRIMARY KEY (conf_file_id, node_id)
356 );
357 CREATE INDEX conf_file_node_conf_file_id_idx ON conf_file_node (conf_file_id);
358 CREATE INDEX conf_file_node_node_id_idx ON conf_file_node (node_id);
359
360 -- Nodes linked to each configuration file
361 CREATE VIEW conf_file_nodes AS
362 SELECT conf_file_id,
363 array_accum(node_id) AS node_ids
364 FROM conf_file_node
365 GROUP BY conf_file_id;
366
367 -- Configuration files linked to each node
368 CREATE VIEW node_conf_files AS
369 SELECT node_id,
370 array_accum(conf_file_id) AS conf_file_ids
371 FROM conf_file_node
372 GROUP BY node_id;
373
374 CREATE TABLE conf_file_nodegroup (
375     conf_file_id integer REFERENCES conf_files NOT NULL, -- Configuration file identifier
376     nodegroup_id integer REFERENCES nodegroups NOT NULL, -- Node group identifier
377     PRIMARY KEY (conf_file_id, nodegroup_id)
378 );
379 CREATE INDEX conf_file_nodegroup_conf_file_id_idx ON conf_file_nodegroup (conf_file_id);
380 CREATE INDEX conf_file_nodegroup_nodegroup_id_idx ON conf_file_nodegroup (nodegroup_id);
381
382 -- Node groups linked to each configuration file
383 CREATE VIEW conf_file_nodegroups AS
384 SELECT conf_file_id,
385 array_accum(nodegroup_id) AS nodegroup_ids
386 FROM conf_file_nodegroup
387 GROUP BY conf_file_id;
388
389 -- Configuration files linked to each node group
390 CREATE VIEW nodegroup_conf_files AS
391 SELECT nodegroup_id,
392 array_accum(conf_file_id) AS conf_file_ids
393 FROM conf_file_nodegroup
394 GROUP BY nodegroup_id;
395
396 --------------------------------------------------------------------------------
397 -- Node network interfaces
398 --------------------------------------------------------------------------------
399
400 -- Valid network addressing schemes
401 CREATE TABLE network_types (
402     type text PRIMARY KEY -- Addressing scheme
403 ) WITH OIDS;
404 INSERT INTO network_types (type) VALUES ('ipv4');
405
406 -- Valid network configuration methods
407 CREATE TABLE network_methods (
408     method text PRIMARY KEY -- Configuration method
409 ) WITH OIDS;
410 INSERT INTO network_methods (method) VALUES ('static');
411 INSERT INTO network_methods (method) VALUES ('dhcp');
412 INSERT INTO network_methods (method) VALUES ('proxy');
413 INSERT INTO network_methods (method) VALUES ('tap');
414 INSERT INTO network_methods (method) VALUES ('ipmi');
415 INSERT INTO network_methods (method) VALUES ('unknown');
416
417 -- Node network interfaces
418 CREATE TABLE nodenetworks (
419     -- Mandatory
420     nodenetwork_id serial PRIMARY KEY, -- Network interface identifier
421     node_id integer REFERENCES nodes NOT NULL, -- Which node
422     is_primary boolean NOT NULL DEFAULT false, -- Is the primary interface for this node
423     type text REFERENCES network_types NOT NULL, -- Addressing scheme
424     method text REFERENCES network_methods NOT NULL, -- Configuration method
425
426     -- Optional, depending on type and method
427     ip text, -- IP address
428     mac text, -- MAC address
429     gateway text, -- Default gateway address
430     network text, -- Network address
431     broadcast text, -- Network broadcast address
432     netmask text, -- Network mask
433     dns1 text, -- Primary DNS server
434     dns2 text, -- Secondary DNS server
435     bwlimit integer, -- Bandwidth limit in bps
436     hostname text -- Hostname of this interface
437 ) WITH OIDS;
438 CREATE INDEX nodenetworks_node_id_idx ON nodenetworks (node_id);
439
440 -- Ordered by primary interface first
441 CREATE VIEW nodenetworks_ordered AS
442 SELECT node_id, nodenetwork_id
443 FROM nodenetworks
444 ORDER BY is_primary DESC;
445
446 -- Network interfaces on each node
447 CREATE VIEW node_nodenetworks AS
448 SELECT node_id,
449 array_accum(nodenetwork_id) AS nodenetwork_ids
450 FROM nodenetworks_ordered
451 GROUP BY node_id;
452
453 --------------------------------------------------------------------------------
454 -- Power control units (PCUs)
455 --------------------------------------------------------------------------------
456
457 CREATE TABLE pcus (
458     -- Mandatory
459     pcu_id serial PRIMARY KEY, -- PCU identifier
460     site_id integer REFERENCES sites NOT NULL, -- Site identifier
461     hostname text, -- Hostname, not necessarily unique (multiple logical sites could use the same PCU)
462     ip text NOT NULL, -- IP, not necessarily unique
463
464     -- Optional
465     protocol text, -- Protocol, e.g. ssh or https or telnet
466     username text, -- Username, if applicable
467     "password" text, -- Password, if applicable
468     model text, -- Model, e.g. BayTech or iPal
469     notes text -- Random notes
470 ) WITH OIDS;
471 CREATE INDEX pcus_site_id_idx ON pcus (site_id);
472
473 CREATE VIEW site_pcus AS
474 SELECT site_id,
475 array_accum(pcu_id) AS pcu_ids
476 FROM pcus
477 GROUP BY site_id;
478
479 CREATE TABLE pcu_node (
480     pcu_id integer REFERENCES pcus NOT NULL, -- PCU identifier
481     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
482     port integer NOT NULL, -- Port number
483     PRIMARY KEY (pcu_id, node_id), -- The same node cannot be controlled by different ports
484     UNIQUE (pcu_id, port) -- The same port cannot control multiple nodes
485 );
486 CREATE INDEX pcu_node_pcu_id_idx ON pcu_node (pcu_id);
487 CREATE INDEX pcu_node_node_id_idx ON pcu_node (node_id);
488
489 CREATE VIEW node_pcus AS
490 SELECT node_id,
491 array_accum(pcu_id) AS pcu_ids,
492 array_accum(port) AS ports
493 FROM pcu_node
494 GROUP BY node_id;
495
496 CREATE VIEW pcu_nodes AS
497 SELECT pcu_id,
498 array_accum(node_id) AS node_ids,
499 array_accum(port) AS ports
500 FROM pcu_node
501 GROUP BY pcu_id;
502
503 --------------------------------------------------------------------------------
504 -- Slices
505 --------------------------------------------------------------------------------
506
507 CREATE TABLE slice_instantiations (
508     instantiation text PRIMARY KEY
509 ) WITH OIDS;
510 INSERT INTO slice_instantiations (instantiation) VALUES ('not-instantiated'); -- Placeholder slice
511 INSERT INTO slice_instantiations (instantiation) VALUES ('plc-instantiated'); -- Instantiated by Node Manager
512 INSERT INTO slice_instantiations (instantiation) VALUES ('delegated'); -- Manually instantiated
513 INSERT INTO slice_instantiations (instantiation) VALUES ('nm-controller'); -- NM Controller
514
515 -- Slices
516 CREATE TABLE slices (
517     slice_id serial PRIMARY KEY, -- Slice identifier
518     site_id integer REFERENCES sites NOT NULL, -- Site identifier
519
520     name text NOT NULL, -- Slice name
521     instantiation text REFERENCES slice_instantiations NOT NULL DEFAULT 'plc-instantiated', -- Slice state, e.g. plc-instantiated
522     url text, -- Project URL
523     description text, -- Project description
524
525     max_nodes integer NOT NULL DEFAULT 100, -- Maximum number of nodes that can be assigned to this slice
526
527     creator_person_id integer REFERENCES persons, -- Creator
528     created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Creation date
529     expires timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP + '2 weeks', -- Expiration date
530
531     is_deleted boolean NOT NULL DEFAULT false
532 ) WITH OIDS;
533 CREATE INDEX slices_site_id_idx ON slices (site_id) WHERE is_deleted IS false;
534 CREATE INDEX slices_name_idx ON slices (name) WHERE is_deleted IS false;
535
536 -- Slivers
537 CREATE TABLE slice_node (
538     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
539     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
540     PRIMARY KEY (slice_id, node_id)
541 ) WITH OIDS;
542 CREATE INDEX slice_node_slice_id_idx ON slice_node (slice_id);
543 CREATE INDEX slice_node_node_id_idx ON slice_node (node_id);
544
545 -- Synonym for slice_node
546 CREATE VIEW slivers AS
547 SELECT * FROM slice_node;
548
549 -- Nodes in each slice
550 CREATE VIEW slice_nodes AS
551 SELECT slice_id,
552 array_accum(node_id) AS node_ids
553 FROM slice_node
554 GROUP BY slice_id;
555
556 -- Slices on each node
557 CREATE VIEW node_slices AS
558 SELECT node_id,
559 array_accum(slice_id) AS slice_ids
560 FROM slice_node
561 GROUP BY node_id;
562
563 -- Slices at each site
564 CREATE VIEW site_slices AS
565 SELECT site_id,
566 array_accum(slice_id) AS slice_ids
567 FROM slices
568 WHERE is_deleted is false
569 GROUP BY site_id;
570
571 -- Slice membership
572 CREATE TABLE slice_person (
573     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
574     person_id integer REFERENCES persons NOT NULL, -- Account identifier
575     PRIMARY KEY (slice_id, person_id)
576 ) WITH OIDS;
577 CREATE INDEX slice_person_slice_id_idx ON slice_person (slice_id);
578 CREATE INDEX slice_person_person_id_idx ON slice_person (person_id);
579
580 -- Members of the slice
581 CREATE VIEW slice_persons AS
582 SELECT slice_id,
583 array_accum(person_id) AS person_ids
584 FROM slice_person
585 GROUP BY slice_id;
586
587 -- Slices of which each person is a member
588 CREATE VIEW person_slices AS
589 SELECT person_id,
590 array_accum(slice_id) AS slice_ids
591 FROM slice_person
592 GROUP BY person_id;
593
594 --------------------------------------------------------------------------------
595 -- Slice whitelist
596 --------------------------------------------------------------------------------
597 -- slice whitelist on nodes
598 CREATE TABLE node_slice_whitelist (
599     node_id integer REFERENCES nodes NOT NULL, -- Node id of whitelist
600     slice_id integer REFERENCES slices NOT NULL, -- Slice id thats allowd on this node
601     PRIMARY KEY (node_id, slice_id)
602 ) WITH OIDS;
603 CREATE INDEX node_slice_whitelist_node_id_idx ON node_slice_whitelist (node_id);
604 CREATE INDEX node_slice_whitelist_slice_id_idx ON node_slice_whitelist (slice_id);
605
606 -- Slices on each node
607 CREATE VIEW node_slices_whitelist AS
608 SELECT node_id,
609 array_accum(slice_id) AS slice_ids_whitelist
610 FROM node_slice_whitelist
611 GROUP BY node_id;
612
613 --------------------------------------------------------------------------------
614 -- Slice attributes
615 --------------------------------------------------------------------------------
616
617 -- Slice attribute types
618 CREATE TABLE slice_attribute_types (
619     attribute_type_id serial PRIMARY KEY, -- Attribute type identifier
620     name text UNIQUE NOT NULL, -- Attribute name
621     description text, -- Attribute description
622     min_role_id integer REFERENCES roles DEFAULT 10 -- If set, minimum (least powerful) role that can set or change this attribute
623 ) WITH OIDS;
624
625 -- Slice/sliver attributes
626 CREATE TABLE slice_attribute (
627     slice_attribute_id serial PRIMARY KEY, -- Slice attribute identifier
628     slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
629     node_id integer REFERENCES nodes, -- Sliver attribute if set
630     nodegroup_id integer REFERENCES nodegroups, -- Node group attribute if set
631     attribute_type_id integer REFERENCES slice_attribute_types NOT NULL, -- Attribute type identifier
632     value text
633 ) WITH OIDS;
634 CREATE INDEX slice_attribute_slice_id_idx ON slice_attribute (slice_id);
635 CREATE INDEX slice_attribute_node_id_idx ON slice_attribute (node_id);
636 CREATE INDEX slice_attribute_nodegroup_id_idx ON slice_attribute (nodegroup_id);
637
638 CREATE VIEW slice_attributes AS
639 SELECT slice_id,
640 array_accum(slice_attribute_id) AS slice_attribute_ids
641 FROM slice_attribute
642 GROUP BY slice_id;
643
644 --------------------------------------------------------------------------------
645 -- Initscripts
646 --------------------------------------------------------------------------------
647
648 -- Initscripts
649 CREATE TABLE initscripts (
650     initscript_id serial PRIMARY KEY, -- Initscript identifier
651     name text NOT NULL, -- Initscript name
652     enabled bool NOT NULL DEFAULT true, -- Initscript is active
653     script text NOT NULL, -- Initscript
654     UNIQUE (name)
655 ) WITH OIDS;
656 CREATE INDEX initscripts_name_idx ON initscripts (name);
657
658
659 --------------------------------------------------------------------------------
660 -- Peers
661 --------------------------------------------------------------------------------
662
663 -- Peers
664 CREATE TABLE peers (
665     peer_id serial PRIMARY KEY, -- Peer identifier
666     peername text NOT NULL, -- Peer name
667     peer_url text NOT NULL, -- (HTTPS) URL of the peer PLCAPI interface
668     cacert text, -- (SSL) Public certificate of peer API server
669     key text, -- (GPG) Public key used for authentication
670     deleted boolean NOT NULL DEFAULT false
671 ) WITH OIDS;
672 CREATE INDEX peers_peername_idx ON peers (peername) WHERE deleted IS false;
673
674 -- Objects at each peer
675 CREATE TABLE peer_site (
676     site_id integer REFERENCES sites PRIMARY KEY, -- Local site identifier
677     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
678     peer_site_id integer NOT NULL, -- Foreign site identifier at peer
679     UNIQUE (peer_id, peer_site_id) -- The same foreign site should not be cached twice
680 ) WITH OIDS;
681 CREATE INDEX peer_site_peer_id_idx ON peers (peer_id);
682
683 CREATE VIEW peer_sites AS
684 SELECT peer_id,
685 array_accum(site_id) AS site_ids,
686 array_accum(peer_site_id) AS peer_site_ids
687 FROM peer_site
688 GROUP BY peer_id;
689
690 CREATE TABLE peer_person (
691     person_id integer REFERENCES persons PRIMARY KEY, -- Local user identifier
692     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
693     peer_person_id integer NOT NULL, -- Foreign user identifier at peer
694     UNIQUE (peer_id, peer_person_id) -- The same foreign user should not be cached twice
695 ) WITH OIDS;
696 CREATE INDEX peer_person_peer_id_idx ON peer_person (peer_id);
697
698 CREATE VIEW peer_persons AS
699 SELECT peer_id,
700 array_accum(person_id) AS person_ids,
701 array_accum(peer_person_id) AS peer_person_ids
702 FROM peer_person
703 GROUP BY peer_id;
704
705 CREATE TABLE peer_key (
706     key_id integer REFERENCES keys PRIMARY KEY, -- Local key identifier
707     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
708     peer_key_id integer NOT NULL, -- Foreign key identifier at peer
709     UNIQUE (peer_id, peer_key_id) -- The same foreign key should not be cached twice
710 ) WITH OIDS;
711 CREATE INDEX peer_key_peer_id_idx ON peer_key (peer_id);
712
713 CREATE VIEW peer_keys AS
714 SELECT peer_id,
715 array_accum(key_id) AS key_ids,
716 array_accum(peer_key_id) AS peer_key_ids
717 FROM peer_key
718 GROUP BY peer_id;
719
720 CREATE TABLE peer_node (
721     node_id integer REFERENCES nodes PRIMARY KEY, -- Local node identifier
722     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
723     peer_node_id integer NOT NULL, -- Foreign node identifier
724     UNIQUE (peer_id, peer_node_id) -- The same foreign node should not be cached twice
725 ) WITH OIDS;
726 CREATE INDEX peer_node_peer_id_idx ON peer_node (peer_id);
727
728 CREATE VIEW peer_nodes AS
729 SELECT peer_id,
730 array_accum(node_id) AS node_ids,
731 array_accum(peer_node_id) AS peer_node_ids
732 FROM peer_node
733 GROUP BY peer_id;
734
735 CREATE TABLE peer_slice (
736     slice_id integer REFERENCES slices PRIMARY KEY, -- Local slice identifier
737     peer_id integer REFERENCES peers NOT NULL, -- Peer identifier
738     peer_slice_id integer NOT NULL, -- Slice identifier at peer
739     UNIQUE (peer_id, peer_slice_id) -- The same foreign slice should not be cached twice
740 ) WITH OIDS;
741 CREATE INDEX peer_slice_peer_id_idx ON peer_slice (peer_id);
742
743 CREATE VIEW peer_slices AS
744 SELECT peer_id,
745 array_accum(slice_id) AS slice_ids,
746 array_accum(peer_slice_id) AS peer_slice_ids
747 FROM peer_slice
748 GROUP BY peer_id;
749
750 --------------------------------------------------------------------------------
751 -- Authenticated sessions
752 --------------------------------------------------------------------------------
753
754 -- Authenticated sessions
755 CREATE TABLE sessions (
756     session_id text PRIMARY KEY, -- Session identifier
757     expires timestamp without time zone
758 ) WITH OIDS;
759
760 -- People can have multiple sessions
761 CREATE TABLE person_session (
762     person_id integer REFERENCES persons NOT NULL, -- Account identifier
763     session_id text REFERENCES sessions NOT NULL, -- Session identifier
764     PRIMARY KEY (person_id, session_id),
765     UNIQUE (session_id) -- Sessions are unique
766 ) WITH OIDS;
767 CREATE INDEX person_session_person_id_idx ON person_session (person_id);
768
769 -- Nodes can have only one session
770 CREATE TABLE node_session (
771     node_id integer REFERENCES nodes NOT NULL, -- Node identifier
772     session_id text REFERENCES sessions NOT NULL, -- Session identifier
773     UNIQUE (node_id), -- Nodes can have only one session
774     UNIQUE (session_id) -- Sessions are unique
775 ) WITH OIDS;
776
777 --------------------------------------------------------------------------------
778 -- Message templates
779 --------------------------------------------------------------------------------
780
781 CREATE TABLE messages (
782     message_id text PRIMARY KEY, -- Message name
783     subject text, -- Message summary
784     template text, -- Message template
785     enabled bool NOT NULL DEFAULT true -- Whether message is enabled
786 ) WITH OIDS;
787
788 --------------------------------------------------------------------------------
789 -- Events
790 --------------------------------------------------------------------------------
791
792 -- Events
793 CREATE TABLE events (
794     event_id serial PRIMARY KEY,  -- Event identifier
795     person_id integer REFERENCES persons, -- Person responsible for event, if any
796     node_id integer REFERENCES nodes, -- Node responsible for event, if any
797     auth_type text, -- Type of auth used. i.e. AuthMethod
798     fault_code integer NOT NULL DEFAULT 0, -- Did this event result in error
799     call_name text NOT NULL, -- Call responsible for this event
800     call text NOT NULL, -- Call responsible for this event, including parameters
801     message text, -- High level description of this event
802     runtime float DEFAULT 0, -- Event run time
803     time timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP -- Event timestamp
804 ) WITH OIDS;
805
806 -- Database object(s) that may have been affected by a particular event
807 CREATE TABLE event_object (
808     event_id integer REFERENCES events NOT NULL, -- Event identifier
809     object_id integer NOT NULL, -- Object identifier
810     object_type text NOT NULL Default 'Unknown' -- What type of object is this event affecting
811 ) WITH OIDS;
812 CREATE INDEX event_object_event_id_idx ON event_object (event_id);
813 CREATE INDEX event_object_object_id_idx ON event_object (object_id);
814 CREATE INDEX event_object_object_type_idx ON event_object (object_type);
815
816 CREATE VIEW event_objects AS
817 SELECT event_id,
818 array_accum(object_id) AS object_ids,
819 array_accum(object_type) AS object_types
820 FROM event_object
821 GROUP BY event_id;
822
823 --------------------------------------------------------------------------------
824 -- Useful views
825 --------------------------------------------------------------------------------
826
827 CREATE OR REPLACE VIEW view_events AS
828 SELECT
829 events.event_id,
830 events.person_id,
831 events.node_id,
832 events.auth_type,
833 events.fault_code,
834 events.call_name,
835 events.call,
836 events.message,
837 events.runtime,
838 CAST(date_part('epoch', events.time) AS bigint) AS time,
839 COALESCE((SELECT object_ids FROM event_objects WHERE event_objects.event_id = events.event_id), '{}') AS object_ids,
840 COALESCE((SELECT object_types FROM event_objects WHERE event_objects.event_id = events.event_id), '{}') AS object_types
841 FROM events;
842
843 CREATE OR REPLACE VIEW view_persons AS
844 SELECT
845 persons.person_id,
846 persons.email,
847 persons.first_name,
848 persons.last_name,
849 persons.deleted,
850 persons.enabled,
851 persons.password,
852 persons.verification_key,
853 CAST(date_part('epoch', persons.verification_expires) AS bigint) AS verification_expires,
854 persons.title,
855 persons.phone,
856 persons.url,
857 persons.bio,
858 CAST(date_part('epoch', persons.date_created) AS bigint) AS date_created,
859 CAST(date_part('epoch', persons.last_updated) AS bigint) AS last_updated,
860 peer_person.peer_id,
861 peer_person.peer_person_id,
862 COALESCE((SELECT role_ids FROM person_roles WHERE person_roles.person_id = persons.person_id), '{}') AS role_ids,
863 COALESCE((SELECT roles FROM person_roles WHERE person_roles.person_id = persons.person_id), '{}') AS roles,
864 COALESCE((SELECT site_ids FROM person_sites WHERE person_sites.person_id = persons.person_id), '{}') AS site_ids,
865 COALESCE((SELECT key_ids FROM person_keys WHERE person_keys.person_id = persons.person_id), '{}') AS key_ids,
866 COALESCE((SELECT slice_ids FROM person_slices WHERE person_slices.person_id = persons.person_id), '{}') AS slice_ids
867 FROM persons
868 LEFT JOIN peer_person USING (person_id);
869
870 CREATE OR REPLACE VIEW view_peers AS
871 SELECT 
872 peers.*, 
873 COALESCE((SELECT site_ids FROM peer_sites WHERE peer_sites.peer_id = peers.peer_id), '{}') AS site_ids,
874 COALESCE((SELECT peer_site_ids FROM peer_sites WHERE peer_sites.peer_id = peers.peer_id), '{}') AS peer_site_ids,
875 COALESCE((SELECT person_ids FROM peer_persons WHERE peer_persons.peer_id = peers.peer_id), '{}') AS person_ids,
876 COALESCE((SELECT peer_person_ids FROM peer_persons WHERE peer_persons.peer_id = peers.peer_id), '{}') AS peer_person_ids,
877 COALESCE((SELECT key_ids FROM peer_keys WHERE peer_keys.peer_id = peers.peer_id), '{}') AS key_ids,
878 COALESCE((SELECT peer_key_ids FROM peer_keys WHERE peer_keys.peer_id = peers.peer_id), '{}') AS peer_key_ids,
879 COALESCE((SELECT node_ids FROM peer_nodes WHERE peer_nodes.peer_id = peers.peer_id), '{}') AS node_ids,
880 COALESCE((SELECT peer_node_ids FROM peer_nodes WHERE peer_nodes.peer_id = peers.peer_id), '{}') AS peer_node_ids,
881 COALESCE((SELECT slice_ids FROM peer_slices WHERE peer_slices.peer_id = peers.peer_id), '{}') AS slice_ids,
882 COALESCE((SELECT peer_slice_ids FROM peer_slices WHERE peer_slices.peer_id = peers.peer_id), '{}') AS peer_slice_ids
883 FROM peers;
884
885 CREATE OR REPLACE VIEW view_nodes AS
886 SELECT
887 nodes.node_id,
888 nodes.hostname,
889 nodes.site_id,
890 nodes.boot_state,
891 nodes.deleted,
892 nodes.model,
893 nodes.boot_nonce,
894 nodes.version,
895 nodes.ssh_rsa_key,
896 nodes.key,
897 CAST(date_part('epoch', nodes.date_created) AS bigint) AS date_created,
898 CAST(date_part('epoch', nodes.last_updated) AS bigint) AS last_updated,
899 CAST(date_part('epoch', nodes.last_contact) AS bigint) AS last_contact,  
900 peer_node.peer_id,
901 peer_node.peer_node_id,
902 COALESCE((SELECT nodenetwork_ids FROM node_nodenetworks WHERE node_nodenetworks.node_id = nodes.node_id), '{}') AS nodenetwork_ids,
903 COALESCE((SELECT nodegroup_ids FROM node_nodegroups WHERE node_nodegroups.node_id = nodes.node_id), '{}') AS nodegroup_ids,
904 COALESCE((SELECT slice_ids FROM node_slices WHERE node_slices.node_id = nodes.node_id), '{}') AS slice_ids,
905 COALESCE((SELECT slice_ids_whitelist FROM node_slices_whitelist WHERE node_slices_whitelist.node_id = nodes.node_id), '{}') AS slice_ids_whitelist,
906 COALESCE((SELECT pcu_ids FROM node_pcus WHERE node_pcus.node_id = nodes.node_id), '{}') AS pcu_ids,
907 COALESCE((SELECT ports FROM node_pcus WHERE node_pcus.node_id = nodes.node_id), '{}') AS ports,
908 COALESCE((SELECT conf_file_ids FROM node_conf_files WHERE node_conf_files.node_id = nodes.node_id), '{}') AS conf_file_ids,
909 node_session.session_id AS session
910 FROM nodes
911 LEFT JOIN peer_node USING (node_id)
912 LEFT JOIN node_session USING (node_id);
913
914 CREATE OR REPLACE VIEW view_nodegroups AS
915 SELECT
916 nodegroups.*,
917 COALESCE((SELECT node_ids FROM nodegroup_nodes WHERE nodegroup_nodes.nodegroup_id = nodegroups.nodegroup_id), '{}') AS node_ids,
918 COALESCE((SELECT conf_file_ids FROM nodegroup_conf_files WHERE nodegroup_conf_files.nodegroup_id = nodegroups.nodegroup_id), '{}') AS conf_file_ids
919 FROM nodegroups;
920
921 CREATE OR REPLACE VIEW view_conf_files AS
922 SELECT
923 conf_files.*,
924 COALESCE((SELECT node_ids FROM conf_file_nodes WHERE conf_file_nodes.conf_file_id = conf_files.conf_file_id), '{}') AS node_ids,
925 COALESCE((SELECT nodegroup_ids FROM conf_file_nodegroups WHERE conf_file_nodegroups.conf_file_id = conf_files.conf_file_id), '{}') AS nodegroup_ids
926 FROM conf_files;
927
928 CREATE OR REPLACE VIEW view_pcus AS
929 SELECT
930 pcus.*,
931 COALESCE((SELECT node_ids FROM pcu_nodes WHERE pcu_nodes.pcu_id = pcus.pcu_id), '{}') AS node_ids,
932 COALESCE((SELECT ports FROM pcu_nodes WHERE pcu_nodes.pcu_id = pcus.pcu_id), '{}') AS ports
933 FROM pcus;
934
935 CREATE OR REPLACE VIEW view_sites AS
936 SELECT
937 sites.site_id,
938 sites.login_base,
939 sites.name,
940 sites.abbreviated_name,
941 sites.deleted,
942 sites.enabled,
943 sites.is_public,
944 sites.max_slices,
945 sites.max_slivers,
946 sites.latitude,
947 sites.longitude,
948 sites.url,
949 sites.ext_consortium_id,
950 CAST(date_part('epoch', sites.date_created) AS bigint) AS date_created,
951 CAST(date_part('epoch', sites.last_updated) AS bigint) AS last_updated,
952 peer_site.peer_id,
953 peer_site.peer_site_id,
954 COALESCE((SELECT person_ids FROM site_persons WHERE site_persons.site_id = sites.site_id), '{}') AS person_ids,
955 COALESCE((SELECT node_ids FROM site_nodes WHERE site_nodes.site_id = sites.site_id), '{}') AS node_ids,
956 COALESCE((SELECT address_ids FROM site_addresses WHERE site_addresses.site_id = sites.site_id), '{}') AS address_ids,
957 COALESCE((SELECT slice_ids FROM site_slices WHERE site_slices.site_id = sites.site_id), '{}') AS slice_ids,
958 COALESCE((SELECT pcu_ids FROM site_pcus WHERE site_pcus.site_id = sites.site_id), '{}') AS pcu_ids
959 FROM sites
960 LEFT JOIN peer_site USING (site_id);
961
962 CREATE OR REPLACE VIEW view_addresses AS
963 SELECT
964 addresses.*,
965 COALESCE((SELECT address_type_ids FROM address_address_types WHERE address_address_types.address_id = addresses.address_id), '{}') AS address_type_ids,
966 COALESCE((SELECT address_types FROM address_address_types WHERE address_address_types.address_id = addresses.address_id), '{}') AS address_types
967 FROM addresses;
968
969 CREATE OR REPLACE VIEW view_keys AS
970 SELECT
971 keys.*,
972 person_key.person_id,
973 peer_key.peer_id,
974 peer_key.peer_key_id
975 FROM keys
976 LEFT JOIN person_key USING (key_id)
977 LEFT JOIN peer_key USING (key_id);
978
979 CREATE OR REPLACE VIEW view_slices AS
980 SELECT
981 slices.slice_id,
982 slices.site_id,
983 slices.name,
984 slices.instantiation,
985 slices.url,
986 slices.description,
987 slices.max_nodes,
988 slices.creator_person_id,
989 slices.is_deleted,
990 CAST(date_part('epoch', slices.created) AS bigint) AS created,
991 CAST(date_part('epoch', slices.expires) AS bigint) AS expires,
992 peer_slice.peer_id,
993 peer_slice.peer_slice_id,
994 COALESCE((SELECT node_ids FROM slice_nodes WHERE slice_nodes.slice_id = slices.slice_id), '{}') AS node_ids,
995 COALESCE((SELECT person_ids FROM slice_persons WHERE slice_persons.slice_id = slices.slice_id), '{}') AS person_ids,
996 COALESCE((SELECT slice_attribute_ids FROM slice_attributes WHERE slice_attributes.slice_id = slices.slice_id), '{}') AS slice_attribute_ids
997 FROM slices
998 LEFT JOIN peer_slice USING (slice_id);
999
1000 CREATE OR REPLACE VIEW view_slice_attributes AS
1001 SELECT
1002 slice_attribute.slice_attribute_id,
1003 slice_attribute.slice_id,
1004 slice_attribute.node_id,
1005 slice_attribute.nodegroup_id,
1006 slice_attribute_types.attribute_type_id,
1007 slice_attribute_types.name,
1008 slice_attribute_types.description,
1009 slice_attribute_types.min_role_id,
1010 slice_attribute.value
1011 FROM slice_attribute
1012 INNER JOIN slice_attribute_types USING (attribute_type_id);
1013
1014 CREATE OR REPLACE VIEW view_sessions AS
1015 SELECT
1016 sessions.session_id,
1017 CAST(date_part('epoch', sessions.expires) AS bigint) AS expires,
1018 person_session.person_id,
1019 node_session.node_id
1020 FROM sessions
1021 LEFT JOIN person_session USING (session_id)
1022 LEFT JOIN node_session USING (session_id);
1023
1024 --------------------------------------------------------------------------------
1025 -- Built-in maintenance account and default site
1026 --------------------------------------------------------------------------------
1027
1028 INSERT INTO persons
1029 (first_name, last_name, email, password, enabled)
1030 VALUES
1031 ('Maintenance', 'Account', 'maint@localhost.localdomain', 'nopass', true);
1032
1033 INSERT INTO person_role (person_id, role_id) VALUES (1, 10);
1034 INSERT INTO person_role (person_id, role_id) VALUES (1, 20);
1035 INSERT INTO person_role (person_id, role_id) VALUES (1, 30);
1036 INSERT INTO person_role (person_id, role_id) VALUES (1, 40);
1037
1038 INSERT INTO sites
1039 (login_base, name, abbreviated_name, max_slices)
1040 VALUES
1041 ('pl', 'PlanetLab Central', 'PLC', 100);