Source Code for Module ganeti.pathutils

  1  # 
  2  # 
  3   
  4  # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Google Inc. 
  5  # All rights reserved. 
  6  # 
  7  # Redistribution and use in source and binary forms, with or without 
  8  # modification, are permitted provided that the following conditions are 
  9  # met: 
 10  # 
 11  # 1. Redistributions of source code must retain the above copyright notice, 
 12  # this list of conditions and the following disclaimer. 
 13  # 
 14  # 2. Redistributions in binary form must reproduce the above copyright 
 15  # notice, this list of conditions and the following disclaimer in the 
 16  # documentation and/or other materials provided with the distribution. 
 17  # 
 18  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 
 19  # IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 20  # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 21  # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
 22  # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 23  # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 24  # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 25  # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 26  # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 27  # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 28  # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 29   
 30   
 31  """Module containing constants and functions for filesystem paths. 
 32   
 33  """ 
 34   
 35  from ganeti import _constants 
 36  from ganeti import compat 
 37  from ganeti import vcluster 
 38   
 39   
 40  # Build-time constants 
 41  DEFAULT_FILE_STORAGE_DIR = "/srv/ganeti/file-storage" 
 42  DEFAULT_FILE_STORAGE_DIR = vcluster.AddNodePrefix(DEFAULT_FILE_STORAGE_DIR) 
 43  DEFAULT_SHARED_FILE_STORAGE_DIR = "/srv/ganeti/shared-file-storage" 
 44  DEFAULT_SHARED_FILE_STORAGE_DIR = \ 
 45      vcluster.AddNodePrefix(DEFAULT_SHARED_FILE_STORAGE_DIR) 
 46  DEFAULT_GLUSTER_STORAGE_DIR = "/var/run/ganeti/gluster" 
 47  DEFAULT_GLUSTER_STORAGE_DIR = \ 
 48      vcluster.AddNodePrefix(DEFAULT_GLUSTER_STORAGE_DIR) 
 49  EXPORT_DIR = vcluster.AddNodePrefix(_constants.EXPORT_DIR) 
 50  BACKUP_DIR = vcluster.AddNodePrefix(_constants.BACKUP_DIR) 
 51  OS_SEARCH_PATH = _constants.OS_SEARCH_PATH 
 52  ES_SEARCH_PATH = _constants.ES_SEARCH_PATH 
 53  SSH_CONFIG_DIR = _constants.SSH_CONFIG_DIR 
 54  XEN_CONFIG_DIR = vcluster.AddNodePrefix(_constants.XEN_CONFIG_DIR) 
 55  SYSCONFDIR = vcluster.AddNodePrefix(_constants.SYSCONFDIR) 
 56  TOOLSDIR = _constants.TOOLSDIR 
 57  PKGLIBDIR = _constants.PKGLIBDIR 
 58  SHAREDIR = _constants.SHAREDIR 
 59  LOCALSTATEDIR = vcluster.AddNodePrefix(_constants.LOCALSTATEDIR) 
 60   
 61  # Paths which don't change for a virtual cluster 
 62  DAEMON_UTIL = _constants.PKGLIBDIR + "/daemon-util" 
 63  IMPORT_EXPORT_DAEMON = _constants.PKGLIBDIR + "/import-export" 
 64  KVM_CONSOLE_WRAPPER = _constants.PKGLIBDIR + "/tools/kvm-console-wrapper" 
 65  KVM_IFUP = _constants.PKGLIBDIR + "/kvm-ifup" 
 66  PREPARE_NODE_JOIN = _constants.PKGLIBDIR + "/prepare-node-join" 
 67  NODE_DAEMON_SETUP = _constants.PKGLIBDIR + "/node-daemon-setup" 
 68  SSL_UPDATE = _constants.PKGLIBDIR + "/ssl-update" 
 69  XEN_CONSOLE_WRAPPER = _constants.PKGLIBDIR + "/tools/xen-console-wrapper" 
 70  CFGUPGRADE = _constants.PKGLIBDIR + "/tools/cfgupgrade" 
 71  POST_UPGRADE = _constants.PKGLIBDIR + "/tools/post-upgrade" 
 72  ENSURE_DIRS = _constants.PKGLIBDIR + "/ensure-dirs" 
 73  # Script to configure the metadata virtual network interface with Xen 
 74  XEN_VIF_METAD_SETUP = _constants.PKGLIBDIR + "/vif-ganeti-metad" 
 75  ETC_HOSTS = vcluster.ETC_HOSTS 
 76   
 77  # Top-level paths 
 78  DATA_DIR = LOCALSTATEDIR + "/lib/ganeti" 
 79  LOCK_DIR = LOCALSTATEDIR + "/lock" 
 80  LOG_DIR = LOCALSTATEDIR + "/log/ganeti" 
 81  RUN_DIR = LOCALSTATEDIR + "/run/ganeti" 
 82   
 83  #: Script to configure master IP address 
 84  DEFAULT_MASTER_SETUP_SCRIPT = TOOLSDIR + "/master-ip-setup" 
 85   
 86  SSH_HOST_DSA_PRIV = _constants.SSH_HOST_DSA_PRIV 
 87  SSH_HOST_DSA_PUB = _constants.SSH_HOST_DSA_PUB 
 88  SSH_HOST_RSA_PRIV = _constants.SSH_HOST_RSA_PRIV 
 89  SSH_HOST_RSA_PUB = _constants.SSH_HOST_RSA_PUB 
 90   
 91  BDEV_CACHE_DIR = RUN_DIR + "/bdev-cache" 
 92  DISK_LINKS_DIR = RUN_DIR + "/instance-disks" 
 93  SOCKET_DIR = RUN_DIR + "/socket" 
 94  CRYPTO_KEYS_DIR = RUN_DIR + "/crypto" 
 95  IMPORT_EXPORT_DIR = RUN_DIR + "/import-export" 
 96  INSTANCE_STATUS_FILE = RUN_DIR + "/instance-status" 
 97  INSTANCE_REASON_DIR = RUN_DIR + "/instance-reason" 
 98  #: User-id pool lock directory (used user IDs have a corresponding lock file in 
 99  #: this directory) 
100  UIDPOOL_LOCKDIR = RUN_DIR + "/uid-pool" 
101  LIVELOCK_DIR = RUN_DIR + "/livelocks" 
102  LUXID_MESSAGE_DIR = RUN_DIR + "/luxidmessages" 
103   
104  SSCONF_LOCK_FILE = LOCK_DIR + "/ganeti-ssconf.lock" 
105   
106  CLUSTER_CONF_FILE = DATA_DIR + "/config.data" 
107  RAPI_CERT_FILE = DATA_DIR + "/rapi.pem" 
108  CONFD_HMAC_KEY = DATA_DIR + "/hmac.key" 
109  SPICE_CERT_FILE = DATA_DIR + "/spice.pem" 
110  SPICE_CACERT_FILE = DATA_DIR + "/spice-ca.pem" 
111  CLUSTER_DOMAIN_SECRET_FILE = DATA_DIR + "/cluster-domain-secret" 
112  SSH_KNOWN_HOSTS_FILE = DATA_DIR + "/known_hosts" 
113  RAPI_DATA_DIR = DATA_DIR + "/rapi" 
114  RAPI_USERS_FILE = RAPI_DATA_DIR + "/users" 
115  QUEUE_DIR = DATA_DIR + "/queue" 
116  INTENT_TO_UPGRADE = DATA_DIR + "/intent-to-upgrade" 
117  CONF_DIR = SYSCONFDIR + "/ganeti" 
118  XEN_IFUP_OS = CONF_DIR + "/xen-ifup-os" 
119  USER_SCRIPTS_DIR = CONF_DIR + "/scripts" 
120  VNC_PASSWORD_FILE = CONF_DIR + "/vnc-cluster-password" 
121  HOOKS_BASE_DIR = CONF_DIR + "/hooks" 
122  FILE_STORAGE_PATHS_FILE = CONF_DIR + "/file-storage-paths" 
123  RESTRICTED_COMMANDS_DIR = CONF_DIR + "/restricted-commands" 
124   
125  #: Node daemon certificate path 
126  NODED_CERT_FILE = DATA_DIR + "/server.pem" 
127  NODED_CLIENT_CERT_FILE = DATA_DIR + "/client.pem" 
128   
129  #: Node daemon certificate file permissions 
130  NODED_CERT_MODE = 0440 
131   
132  #: Locked in exclusive mode while noded verifies a remote command 
133  RESTRICTED_COMMANDS_LOCK_FILE = LOCK_DIR + "/ganeti-restricted-commands.lock" 
134   
135  #: Lock file for watcher, locked in shared mode by watcher; lock in exclusive 
136  # mode to block watcher (see L{cli._RunWhileDaemonsStoppedHelper.Call} 
137  WATCHER_LOCK_FILE = LOCK_DIR + "/ganeti-watcher.lock" 
138   
139  #: Status file for per-group watcher, locked in exclusive mode by watcher 
140  WATCHER_GROUP_STATE_FILE = DATA_DIR + "/watcher.%s.data" 
141   
142  #: File for per-group instance status, merged into L{INSTANCE_STATUS_FILE} by 
143  #: per-group processes 
144  WATCHER_GROUP_INSTANCE_STATUS_FILE = DATA_DIR + "/watcher.%s.instance-status" 
145   
146  #: File containing Unix timestamp until which watcher should be paused 
147  WATCHER_PAUSEFILE = DATA_DIR + "/watcher.pause" 
148   
149  #: User-provided master IP setup script 
150  EXTERNAL_MASTER_SETUP_SCRIPT = USER_SCRIPTS_DIR + "/master-ip-setup" 
151   
152  #: LUXI socket used for job execution 
153  MASTER_SOCKET = SOCKET_DIR + "/ganeti-master" 
154  #: LUXI socket used for queries only 
155  QUERY_SOCKET = SOCKET_DIR + "/ganeti-query" 
156  #: WConfD socket 
157  WCONFD_SOCKET = SOCKET_DIR + "/ganeti-wconfd" 
158   
159  LOG_OS_DIR = LOG_DIR + "/os" 
160  LOG_ES_DIR = LOG_DIR + "/extstorage" 
161  #: Directory for storing Xen config files after failed instance starts 
162  LOG_XEN_DIR = LOG_DIR + "/xen" 
163   
164  # Job queue paths 
165  JOB_QUEUE_LOCK_FILE = QUEUE_DIR + "/lock" 
166  JOB_QUEUE_VERSION_FILE = QUEUE_DIR + "/version" 
167  JOB_QUEUE_SERIAL_FILE = QUEUE_DIR + "/serial" 
168  JOB_QUEUE_ARCHIVE_DIR = QUEUE_DIR + "/archive" 
169  JOB_QUEUE_DRAIN_FILE = QUEUE_DIR + "/drain" 
170   
171  ALL_CERT_FILES = compat.UniqueFrozenset([ 
172    NODED_CERT_FILE, 
173    RAPI_CERT_FILE, 
174    SPICE_CERT_FILE, 
175    SPICE_CACERT_FILE, 
176    ]) 
177   
178   
179 -def GetLogFilename(daemon_name): 
180    """Returns the full path for a daemon's log file. 
181   
182    """ 
183    return "%s/%s.log" % (LOG_DIR, daemon_name) 
184   
185   
186  LOG_WATCHER = GetLogFilename("watcher") 
187  LOG_COMMANDS = GetLogFilename("commands") 
188  LOG_BURNIN = GetLogFilename("burnin") 
189