2 -- PlanetLab Central database schema
3 -- Version 4, PostgreSQL
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>
10 -- Copyright (C) 2006 The Trustees of Princeton University
12 -- $Id: planetlab4.sql,v 1.6 2006/10/06 18:19:07 mlhuang Exp $
15 --------------------------------------------------------------------------------
16 -- Aggregates and store procedures
17 --------------------------------------------------------------------------------
19 -- Like MySQL GROUP_CONCAT(), this function aggregates values into a
21 CREATE AGGREGATE array_accum (
23 basetype = anyelement,
28 --------------------------------------------------------------------------------
30 --------------------------------------------------------------------------------
33 CREATE TABLE persons (
35 person_id serial PRIMARY KEY, -- Account identifier
36 email text NOT NULL, -- E-mail address
37 first_name text NOT NULL, -- First name
38 last_name text NOT NULL, -- Last name
39 deleted boolean NOT NULL DEFAULT false, -- Has been deleted
40 enabled boolean NOT NULL DEFAULT false, -- Has been disabled
43 password text NOT NULL, -- Password (md5crypted)
44 verification_key text, -- Reset password key
45 verification_expires timestamp without time zone,
48 title text, -- Honorific
49 phone text, -- Telephone number
50 url text, -- Home page
51 bio text, -- Biography
54 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
55 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
57 CREATE INDEX persons_email_key ON persons (email) WHERE deleted IS false;
59 --------------------------------------------------------------------------------
61 --------------------------------------------------------------------------------
66 site_id serial PRIMARY KEY, -- Site identifier
67 login_base text NOT NULL, -- Site slice prefix
68 name text NOT NULL, -- Site name
69 abbreviated_name text NOT NULL, -- Site abbreviated name
70 deleted boolean NOT NULL DEFAULT false, -- Has been deleted
71 is_public boolean NOT NULL DEFAULT true, -- Shows up in public lists
72 max_slices integer NOT NULL DEFAULT 0, -- Maximum number of slices
73 max_slivers integer NOT NULL DEFAULT 1000, -- Maximum number of instantiated slivers
81 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
82 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
84 CREATE INDEX sites_login_base_key ON sites (login_base) WHERE deleted IS false;
86 -- Account site membership
87 CREATE TABLE person_site (
88 person_id integer REFERENCES persons NOT NULL, -- Account identifier
89 site_id integer REFERENCES sites NOT NULL, -- Site identifier
90 is_primary boolean NOT NULL DEFAULT false, -- Is the primary site for this account
91 PRIMARY KEY (person_id, site_id)
93 CREATE INDEX person_site_person_id_key ON person_site (person_id);
94 CREATE INDEX person_site_site_id_key ON person_site (site_id);
96 -- Ordered by primary site first
97 CREATE VIEW person_site_ordered AS
98 SELECT person_id, site_id
100 ORDER BY is_primary DESC;
102 -- Sites that each person is a member of
103 CREATE VIEW person_sites AS
105 array_to_string(array_accum(site_id), ',') AS site_ids
106 FROM person_site_ordered
109 -- Accounts at each site
110 CREATE VIEW site_persons AS
112 array_to_string(array_accum(person_id), ',') AS person_ids
116 --------------------------------------------------------------------------------
118 --------------------------------------------------------------------------------
120 CREATE TABLE address_types (
121 address_type_id serial PRIMARY KEY, -- Address type identifier
122 name text UNIQUE NOT NULL, -- Address type
123 description text -- Address type description
125 INSERT INTO address_types (name) VALUES ('Personal');
126 INSERT INTO address_types (name) VALUES ('Shipping');
127 -- XXX Used to be Site
128 INSERT INTO address_types (name) VALUES ('Billing');
131 CREATE TABLE addresses (
132 address_id serial PRIMARY KEY, -- Address identifier
133 site_id integer REFERENCES sites NOT NULL, -- Site identifier
134 line1 text NOT NULL, -- Address line 1
135 line2 text, -- Address line 2
136 line3 text, -- Address line 3
137 city text NOT NULL, -- City
138 state text NOT NULL, -- State or province
139 postalcode text NOT NULL, -- Postal code
140 country text NOT NULL -- Country
143 -- Each mailing address can be one of several types
144 CREATE TABLE address_address_type (
145 address_id integer REFERENCES addresses NOT NULL, -- Address identifier
146 address_type_id integer REFERENCES address_types NOT NULL -- Address type
149 CREATE VIEW address_address_types AS
151 array_to_string(array_accum(address_type_id), ',') AS address_type_ids,
152 array_to_string(array_accum(address_types.name), ',') AS address_types
153 FROM address_address_type
154 LEFT JOIN address_types USING (address_type_id)
157 CREATE VIEW site_addresses AS
159 array_to_string(array_accum(address_id), ',') AS address_ids
163 --------------------------------------------------------------------------------
164 -- Authentication Keys
165 --------------------------------------------------------------------------------
168 CREATE TABLE key_types (
169 key_type text PRIMARY KEY -- Key type
171 INSERT INTO key_types (key_type) VALUES ('ssh');
173 -- Authentication keys
175 key_id serial PRIMARY KEY, -- Key identifier
176 key_type text REFERENCES key_types NOT NULL, -- Key type
177 key text NOT NULL, -- Key material
178 is_blacklisted boolean NOT NULL DEFAULT false -- Has been blacklisted
181 -- Account authentication key(s)
182 CREATE TABLE person_key (
183 person_id integer REFERENCES persons NOT NULL, -- Account identifier
184 key_id integer REFERENCES keys NOT NULL, -- Key identifier
185 is_primary boolean NOT NULL DEFAULT false, -- Is the primary key for this account
186 PRIMARY KEY (person_id, key_id)
188 CREATE INDEX person_key_person_id_key ON person_key (person_id);
189 CREATE INDEX person_key_key_id_key ON person_key (key_id);
191 CREATE VIEW person_keys AS
193 array_to_string(array_accum(key_id), ',') AS key_ids
197 --------------------------------------------------------------------------------
199 --------------------------------------------------------------------------------
201 -- Valid account roles
203 role_id integer PRIMARY KEY, -- Role identifier
204 name text UNIQUE NOT NULL -- Role symbolic name
206 INSERT INTO roles (role_id, name) VALUES (10, 'admin');
207 INSERT INTO roles (role_id, name) VALUES (20, 'pi');
208 INSERT INTO roles (role_id, name) VALUES (30, 'user');
209 INSERT INTO roles (role_id, name) VALUES (40, 'tech');
210 INSERT INTO roles (role_id, name) VALUES (1000, 'node');
211 INSERT INTO roles (role_id, name) VALUES (2000, 'anonymous');
213 CREATE TABLE person_role (
214 person_id integer REFERENCES persons NOT NULL, -- Account identifier
215 role_id integer REFERENCES roles NOT NULL, -- Role identifier
216 PRIMARY KEY (person_id, role_id)
218 CREATE INDEX person_role_person_id_key ON person_role (person_id);
221 CREATE VIEW person_roles AS
223 array_to_string(array_accum(role_id), ',') AS role_ids,
224 array_to_string(array_accum(roles.name), ',') AS roles
226 LEFT JOIN roles USING (role_id)
229 --------------------------------------------------------------------------------
231 --------------------------------------------------------------------------------
233 -- Valid node boot states
234 CREATE TABLE boot_states (
235 boot_state text PRIMARY KEY
237 INSERT INTO boot_states (boot_state) VALUES ('boot');
238 INSERT INTO boot_states (boot_state) VALUES ('dbg');
239 INSERT INTO boot_states (boot_state) VALUES ('inst');
240 INSERT INTO boot_states (boot_state) VALUES ('rins');
241 INSERT INTO boot_states (boot_state) VALUES ('rcnf');
242 INSERT INTO boot_states (boot_state) VALUES ('new');
247 node_id serial PRIMARY KEY, -- Node identifier
248 hostname text NOT NULL, -- Node hostname
249 site_id integer REFERENCES sites NOT NULL, -- At which site
250 boot_state text REFERENCES boot_states NOT NULL, -- Node boot state
251 deleted boolean NOT NULL DEFAULT false, -- Is deleted
254 model text, -- Hardware make and model
255 boot_nonce text, -- Random nonce updated by Boot Manager
256 version text, -- Boot CD version string updated by Boot Manager
257 -- XXX Should be key_id integer REFERENCES keys
258 ssh_rsa_key text, -- SSH host key updated by Boot Manager
259 key text, -- Node key generated by API when configuration file is downloaded
260 session text, -- Session key generated by PLC when Boot Manager authenticates
263 date_created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP,
264 last_updated timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP
266 CREATE INDEX nodes_hostname_key ON nodes (hostname) WHERE deleted IS false;
267 CREATE INDEX nodes_site_id_key ON nodes (site_id) WHERE deleted IS false;
269 -- Nodes at each site
270 CREATE VIEW site_nodes AS
272 array_to_string(array_accum(node_id), ',') AS node_ids
276 --------------------------------------------------------------------------------
278 --------------------------------------------------------------------------------
281 CREATE TABLE nodegroups (
282 nodegroup_id serial PRIMARY KEY, -- Group identifier
283 name text UNIQUE NOT NULL, -- Group name
284 description text -- Group description
287 -- Node group membership
288 CREATE TABLE nodegroup_node (
289 nodegroup_id integer REFERENCES nodegroups NOT NULL, -- Group identifier
290 node_id integer REFERENCES nodes NOT NULL, -- Node identifier
291 PRIMARY KEY (nodegroup_id, node_id)
293 CREATE INDEX nodegroup_node_nodegroup_id_key ON nodegroup_node (nodegroup_id);
294 CREATE INDEX nodegroup_node_node_id_key ON nodegroup_node (node_id);
296 -- Nodes in each node gruop
297 CREATE VIEW nodegroup_nodes AS
299 array_to_string(array_accum(node_id), ',') AS node_ids
301 GROUP BY nodegroup_id;
303 -- Node groups that each node is a member of
304 CREATE VIEW node_nodegroups AS
306 array_to_string(array_accum(nodegroup_id), ',') AS nodegroup_ids
310 --------------------------------------------------------------------------------
311 -- Node network interfaces
312 --------------------------------------------------------------------------------
314 -- Valid network addressing schemes
315 CREATE TABLE network_types (
316 type text PRIMARY KEY -- Addressing scheme
318 INSERT INTO network_types (type) VALUES ('ipv4');
319 INSERT INTO network_types (type) VALUES ('ipv6');
321 -- Valid network configuration methods
322 CREATE TABLE network_methods (
323 method text PRIMARY KEY -- Configuration method
325 INSERT INTO network_methods (method) VALUES ('static');
326 INSERT INTO network_methods (method) VALUES ('dhcp');
327 INSERT INTO network_methods (method) VALUES ('proxy');
328 INSERT INTO network_methods (method) VALUES ('tap');
329 INSERT INTO network_methods (method) VALUES ('ipmi');
330 INSERT INTO network_methods (method) VALUES ('unknown');
332 -- Node network interfaces
333 CREATE TABLE nodenetworks (
335 nodenetwork_id serial PRIMARY KEY, -- Network interface identifier
336 node_id integer REFERENCES nodes NOT NULL, -- Which node
337 is_primary boolean NOT NULL DEFAULT false, -- Is the primary interface for this node
338 type text REFERENCES network_types NOT NULL, -- Addressing scheme
339 method text REFERENCES network_methods NOT NULL, -- Configuration method
341 -- Optional, depending on type and method
342 ip text, -- IP address
343 mac text, -- MAC address
344 gateway text, -- Default gateway address
345 network text, -- Network address
346 broadcast text, -- Network broadcast address
347 netmask text, -- Network mask
348 dns1 text, -- Primary DNS server
349 dns2 text, -- Secondary DNS server
350 bwlimit integer, -- Bandwidth limit in bps
351 hostname text -- Hostname of this interface
353 CREATE INDEX nodenetworks_node_id_key ON nodenetworks (node_id);
355 -- Ordered by primary interface first
356 CREATE VIEW nodenetworks_ordered AS
357 SELECT node_id, nodenetwork_id
359 ORDER BY is_primary DESC;
361 -- Network interfaces on each node
362 CREATE VIEW node_nodenetworks AS
364 array_to_string(array_accum(nodenetwork_id), ',') AS nodenetwork_ids
365 FROM nodenetworks_ordered
368 --------------------------------------------------------------------------------
369 -- Power control units (PCUs)
370 --------------------------------------------------------------------------------
374 pcu_id serial PRIMARY KEY, -- PCU identifier
375 site_id integer REFERENCES sites NOT NULL, -- Site identifier
376 hostname text NOT NULL, -- Hostname, not necessarily unique (multiple logical sites could use the same PCU)
377 ip text NOT NULL, -- IP, not necessarily unique
380 protocol text, -- Protocol, e.g. ssh or https or telnet
381 username text, -- Username, if applicable
382 "password" text, -- Password, if applicable
383 model text, -- Model, e.g. BayTech or iPal
384 notes text -- Random notes
387 CREATE TABLE pcu_node (
388 pcu_id integer REFERENCES pcus NOT NULL, -- PCU identifier
389 node_id integer REFERENCES nodes NOT NULL, -- Node identifier
390 port integer NOT NULL, -- Port number
391 PRIMARY KEY (pcu_id, node_id)
393 CREATE INDEX pcu_node_pcu_id_key ON pcu_node (pcu_id);
394 CREATE INDEX pcu_node_node_id_key ON pcu_node (node_id);
396 CREATE VIEW pcu_nodes AS
398 array_to_string(array_accum(node_id), ',') AS node_ids,
399 array_to_string(array_accum(port), ',') AS ports
403 --------------------------------------------------------------------------------
405 --------------------------------------------------------------------------------
407 CREATE TABLE slice_instantiations (
408 instantiation text PRIMARY KEY
410 INSERT INTO slice_instantiations (instantiation) VALUES ('not-instantiated'); -- Placeholder slice
411 INSERT INTO slice_instantiations (instantiation) VALUES ('plc-instantiated'); -- Instantiated by Node Manager
412 INSERT INTO slice_instantiations (instantiation) VALUES ('delegated'); -- Manually instantiated
415 CREATE TABLE slices (
416 slice_id serial PRIMARY KEY, -- Slice identifier
417 site_id integer REFERENCES sites NOT NULL, -- Site identifier
418 name text NOT NULL, -- Slice name
419 instantiation text REFERENCES slice_instantiations NOT NULL DEFAULT 'plc-instantiated', -- Slice state, e.g. plc-instantiated
420 url text, -- Project URL
421 description text, -- Project description
423 max_nodes integer NOT NULL DEFAULT 100, -- Maximum number of nodes that can be assigned to this slice
425 creator_person_id integer REFERENCES persons NOT NULL, -- Creator
426 created timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Creation date
427 expires timestamp without time zone NOT NULL DEFAULT CURRENT_TIMESTAMP + '2 weeks', -- Expiration date
429 is_deleted boolean NOT NULL DEFAULT false
431 CREATE INDEX slices_site_id_key ON slices (site_id) WHERE is_deleted IS false;
432 CREATE INDEX slices_name_key ON slices (name) WHERE is_deleted IS false;
435 CREATE TABLE slice_node (
436 slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
437 node_id integer REFERENCES nodes NOT NULL -- Node identifier
439 CREATE INDEX slice_node_slice_id_key ON slice_node (slice_id);
440 CREATE INDEX slice_node_node_id_key ON slice_node (node_id);
442 -- Synonym for slice_node
443 CREATE VIEW slivers AS
444 SELECT * FROM slice_node;
446 -- Nodes in each slice
447 CREATE VIEW slice_nodes AS
449 array_to_string(array_accum(node_id), ',') AS node_ids
453 -- Slices on each node
454 CREATE VIEW node_slices AS
456 array_to_string(array_accum(slice_id), ',') AS slice_ids
460 -- Slices at each site
461 CREATE VIEW site_slices AS
463 array_to_string(array_accum(slice_id), ',') AS slice_ids
468 CREATE TABLE slice_person (
469 slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
470 person_id integer REFERENCES persons NOT NULL, -- Account identifier
471 PRIMARY KEY (slice_id, person_id)
473 CREATE INDEX slice_person_slice_id_key ON slice_person (slice_id);
474 CREATE INDEX slice_person_person_id_key ON slice_person (person_id);
476 -- Members of the slice
477 CREATE VIEW slice_persons AS
479 array_to_string(array_accum(person_id), ',') AS person_ids
483 -- Slices of which each person is a member
484 CREATE VIEW person_slices AS
486 array_to_string(array_accum(slice_id), ',') AS slice_ids
490 --------------------------------------------------------------------------------
492 --------------------------------------------------------------------------------
494 -- Generic attribute types
495 CREATE TABLE attributes (
496 attribute_id serial PRIMARY KEY, -- Attribute type identifier
497 name text UNIQUE NOT NULL, -- Attribute name
498 description text, -- Attribute description
499 min_role_id integer REFERENCES roles DEFAULT 10 -- If set, minimum (least powerful) role that can set or change this attribute
502 -- Slice/sliver attributes
503 CREATE TABLE slice_attribute (
504 slice_attribute_id serial PRIMARY KEY, -- Slice attribute identifier
505 slice_id integer REFERENCES slices NOT NULL, -- Slice identifier
506 node_id integer REFERENCES nodes, -- Sliver attribute if set
507 attribute_id integer REFERENCES attributes NOT NULL, -- Attribute identifier
510 CREATE INDEX slice_attribute_slice_id_key ON slice_attribute (slice_id);
511 CREATE INDEX slice_attribute_node_id_key ON slice_attribute (node_id);
513 CREATE VIEW slice_attributes AS
515 array_to_string(array_accum(slice_attribute_id), ',') AS slice_attribute_ids
520 CREATE TABLE node_attribute (
521 node_attribute_id serial PRIMARY KEY, -- Node attribute identifier
522 node_id integer REFERENCES nodes NOT NULL, -- Node identifier
523 attribute_id integer REFERENCES attributes NOT NULL, -- Attribute identifier
526 CREATE INDEX node_attribute_node_id_key ON node_attribute (node_id);
528 CREATE VIEW node_attributes AS
530 array_to_string(array_accum(node_attribute_id), ',') AS node_attribute_ids
534 --------------------------------------------------------------------------------
536 --------------------------------------------------------------------------------
538 CREATE VIEW view_persons AS
547 persons.verification_key,
548 persons.verification_expires,
553 CAST(date_part('epoch', persons.date_created) AS bigint) AS date_created,
554 CAST(date_part('epoch', persons.last_updated) AS bigint) AS last_updated,
555 person_roles.role_ids, person_roles.roles,
556 person_sites.site_ids,
558 person_slices.slice_ids
560 LEFT JOIN person_roles USING (person_id)
561 LEFT JOIN person_sites USING (person_id)
562 LEFT JOIN person_keys USING (person_id)
563 LEFT JOIN person_slices USING (person_id);
565 CREATE VIEW view_nodes AS
578 CAST(date_part('epoch', nodes.date_created) AS bigint) AS date_created,
579 CAST(date_part('epoch', nodes.last_updated) AS bigint) AS last_updated,
580 node_nodenetworks.nodenetwork_ids,
581 node_nodegroups.nodegroup_ids,
582 node_slices.slice_ids
584 LEFT JOIN node_nodenetworks USING (node_id)
585 LEFT JOIN node_nodegroups USING (node_id)
586 LEFT JOIN node_slices USING (node_id);
588 CREATE VIEW view_node_attributes AS
590 node_attribute.node_attribute_id,
591 node_attribute.node_id,
592 attributes.attribute_id,
594 attributes.description,
595 attributes.min_role_id,
598 INNER JOIN attributes USING (attribute_id);
600 CREATE VIEW view_nodegroups AS
602 nodegroups.nodegroup_id,
604 nodegroups.description,
605 nodegroup_nodes.node_ids
607 LEFT JOIN nodegroup_nodes USING (nodegroup_id);
609 CREATE VIEW view_sites AS
614 sites.abbreviated_name,
622 CAST(date_part('epoch', sites.date_created) AS bigint) AS date_created,
623 CAST(date_part('epoch', sites.last_updated) AS bigint) AS last_updated,
624 site_persons.person_ids,
626 site_addresses.address_ids,
627 site_slices.slice_ids
629 LEFT JOIN site_persons USING (site_id)
630 LEFT JOIN site_nodes USING (site_id)
631 LEFT JOIN site_addresses USING (site_id)
632 LEFT JOIN site_slices USING (site_id);
634 CREATE VIEW view_addresses AS
636 addresses.address_id,
643 addresses.postalcode,
645 address_address_types.address_type_ids,
646 address_address_types.address_types
648 LEFT JOIN address_address_types USING (address_id);
650 CREATE VIEW view_slices AS
655 slices.instantiation,
659 slices.creator_person_id,
661 CAST(date_part('epoch', slices.created) AS bigint) AS created,
662 CAST(date_part('epoch', slices.expires) AS bigint) AS expires,
663 slice_nodes.node_ids,
664 slice_persons.person_ids,
665 slice_attributes.slice_attribute_ids
667 LEFT JOIN slice_nodes USING (slice_id)
668 LEFT JOIN slice_persons USING (slice_id)
669 LEFT JOIN slice_attributes USING (slice_id);
671 CREATE VIEW view_slice_attributes AS
673 slice_attribute.slice_attribute_id,
674 slice_attribute.slice_id,
675 slice_attribute.node_id,
676 attributes.attribute_id,
678 attributes.description,
679 attributes.min_role_id,
680 slice_attribute.value
682 INNER JOIN attributes USING (attribute_id);
684 --------------------------------------------------------------------------------
685 -- Built-in maintenance account and default site
686 --------------------------------------------------------------------------------
689 (first_name, last_name, email, password, enabled)
691 ('Maintenance', 'Account', 'maint@localhost.localdomain', 'nopass', true);
693 INSERT INTO person_role (person_id, role_id) VALUES (1, 10);
694 INSERT INTO person_role (person_id, role_id) VALUES (1, 20);
695 INSERT INTO person_role (person_id, role_id) VALUES (1, 30);
696 INSERT INTO person_role (person_id, role_id) VALUES (1, 40);
699 (login_base, name, abbreviated_name, max_slices)
701 ('pl', 'PlanetLab Central', 'PLC', 100);