Provide the canonical path to cfgupgrade in pathutils
[ganeti-local] / lib / pathutils.py
1 #
2 #
3
4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Google Inc.
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301, USA.
20
21
22 """Module containing constants and functions for filesystem paths.
23
24 """
25
26 from ganeti import _constants
27 from ganeti import compat
28 from ganeti import vcluster
29
30
31 # Build-time constants
32 DEFAULT_FILE_STORAGE_DIR = "/srv/ganeti/file-storage"
33 DEFAULT_FILE_STORAGE_DIR = vcluster.AddNodePrefix(DEFAULT_FILE_STORAGE_DIR)
34 DEFAULT_SHARED_FILE_STORAGE_DIR = "/srv/ganeti/shared-file-storage"
35 DEFAULT_SHARED_FILE_STORAGE_DIR = \
36     vcluster.AddNodePrefix(DEFAULT_SHARED_FILE_STORAGE_DIR)
37 EXPORT_DIR = vcluster.AddNodePrefix(_constants.EXPORT_DIR)
38 OS_SEARCH_PATH = _constants.OS_SEARCH_PATH
39 ES_SEARCH_PATH = _constants.ES_SEARCH_PATH
40 SSH_CONFIG_DIR = _constants.SSH_CONFIG_DIR
41 XEN_CONFIG_DIR = vcluster.AddNodePrefix(_constants.XEN_CONFIG_DIR)
42 SYSCONFDIR = vcluster.AddNodePrefix(_constants.SYSCONFDIR)
43 TOOLSDIR = _constants.TOOLSDIR
44 PKGLIBDIR = _constants.PKGLIBDIR
45 LOCALSTATEDIR = vcluster.AddNodePrefix(_constants.LOCALSTATEDIR)
46
47 # Paths which don't change for a virtual cluster
48 DAEMON_UTIL = _constants.PKGLIBDIR + "/daemon-util"
49 IMPORT_EXPORT_DAEMON = _constants.PKGLIBDIR + "/import-export"
50 KVM_CONSOLE_WRAPPER = _constants.PKGLIBDIR + "/tools/kvm-console-wrapper"
51 KVM_IFUP = _constants.PKGLIBDIR + "/kvm-ifup"
52 PREPARE_NODE_JOIN = _constants.PKGLIBDIR + "/prepare-node-join"
53 NODE_DAEMON_SETUP = _constants.PKGLIBDIR + "/node-daemon-setup"
54 XEN_CONSOLE_WRAPPER = _constants.PKGLIBDIR + "/tools/xen-console-wrapper"
55 CFGUPGRADE = _constants.PKGLIBDIR + "/tools/cfgupgrade"
56 ETC_HOSTS = vcluster.ETC_HOSTS
57
58 # Top-level paths
59 DATA_DIR = LOCALSTATEDIR + "/lib/ganeti"
60 LOCK_DIR = LOCALSTATEDIR + "/lock"
61 LOG_DIR = LOCALSTATEDIR + "/log/ganeti"
62 RUN_DIR = LOCALSTATEDIR + "/run/ganeti"
63
64 #: Script to configure master IP address
65 DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup"
66
67 SSH_HOST_DSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_dsa_key"
68 SSH_HOST_DSA_PUB = SSH_HOST_DSA_PRIV + ".pub"
69 SSH_HOST_RSA_PRIV = SSH_CONFIG_DIR + "/ssh_host_rsa_key"
70 SSH_HOST_RSA_PUB = SSH_HOST_RSA_PRIV + ".pub"
71
72 BDEV_CACHE_DIR = RUN_DIR + "/bdev-cache"
73 DISK_LINKS_DIR = RUN_DIR + "/instance-disks"
74 SOCKET_DIR = RUN_DIR + "/socket"
75 CRYPTO_KEYS_DIR = RUN_DIR + "/crypto"
76 IMPORT_EXPORT_DIR = RUN_DIR + "/import-export"
77 INSTANCE_STATUS_FILE = RUN_DIR + "/instance-status"
78 INSTANCE_REASON_DIR = RUN_DIR + "/instance-reason"
79 #: User-id pool lock directory (used user IDs have a corresponding lock file in
80 #: this directory)
81 UIDPOOL_LOCKDIR = RUN_DIR + "/uid-pool"
82
83 SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock"
84
85 CLUSTER_CONF_FILE = DATA_DIR + "/config.data"
86 RAPI_CERT_FILE = DATA_DIR + "/rapi.pem"
87 CONFD_HMAC_KEY = DATA_DIR + "/hmac.key"
88 SPICE_CERT_FILE = DATA_DIR + "/spice.pem"
89 SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem"
90 CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret"
91 SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts"
92 RAPI_USERS_FILE = DATA_DIR + "/rapi/users"
93 QUEUE_DIR = DATA_DIR + "/queue"
94 CONF_DIR = SYSCONFDIR + "/ganeti"
95 USER_SCRIPTS_DIR = CONF_DIR + "/scripts"
96 VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password"
97 HOOKS_BASE_DIR = CONF_DIR + "/hooks"
98 FILE_STORAGE_PATHS_FILE = CONF_DIR + "/file-storage-paths"
99 RESTRICTED_COMMANDS_DIR = CONF_DIR + "/restricted-commands"
100
101 #: Node daemon certificate path
102 NODED_CERT_FILE = DATA_DIR + "/server.pem"
103
104 #: Node daemon certificate file permissions
105 NODED_CERT_MODE = 0440
106
107 #: Locked in exclusive mode while noded verifies a remote command
108 RESTRICTED_COMMANDS_LOCK_FILE = LOCK_DIR + "/ganeti-restricted-commands.lock"
109
110 #: Lock file for watcher, locked in shared mode by watcher; lock in exclusive
111 # mode to block watcher (see L{cli._RunWhileClusterStoppedHelper.Call}
112 WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock"
113
114 #: Status file for per-group watcher, locked in exclusive mode by watcher
115 WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data"
116
117 #: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by
118 #: per-group processes
119 WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status"
120
121 #: File containing Unix timestamp until which watcher should be paused
122 WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause"
123
124 #: User-provided master IP setup script
125 EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup"
126
127 #: LUXI socket used for job execution
128 MASTER_SOCKET = SOCKET_DIR + "/ganeti-master"
129 #: LUXI socket used for queries only
130 QUERY_SOCKET = SOCKET_DIR + "/ganeti-query"
131
132 LOG_OS_DIR = LOG_DIR + "/os"
133 LOG_ES_DIR = LOG_DIR + "/extstorage"
134 #: Directory for storing Xen config files after failed instance starts
135 LOG_XEN_DIR = LOG_DIR + "/xen"
136
137 # Job queue paths
138 JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock"
139 JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version"
140 JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial"
141 JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive"
142 JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain"
143
144 ALL_CERT_FILES = compat.UniqueFrozenset([
145   NODED_CERT_FILE,
146   RAPI_CERT_FILE,
147   SPICE_CERT_FILE,
148   SPICE_CACERT_FILE,
149   ])
150
151
152 def GetLogFilename(daemon_name):
153   """Returns the full path for a daemon's log file.
154
155   """
156   return "%s/%s.log" % (LOG_DIR, daemon_name)
157
158
159 LOG_WATCHER = GetLogFilename("watcher")
160 LOG_COMMANDS = GetLogFilename("commands")
161 LOG_BURNIN = GetLogFilename("burnin")