Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # |
| 3 | # Copyright 2016 the original author or authors. |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | # |
| 17 | |
Zsolt Haraszti | adbb88d | 2016-09-12 21:24:57 -0700 | [diff] [blame] | 18 | """Virtual OLT Hardware Abstraction main entry point""" |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 19 | |
| 20 | import argparse |
Zsolt Haraszti | d7c7c48 | 2016-09-13 00:45:38 -0700 | [diff] [blame] | 21 | import os |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 22 | import time |
Zsolt Haraszti | d7c7c48 | 2016-09-13 00:45:38 -0700 | [diff] [blame] | 23 | import yaml |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 24 | from twisted.internet.defer import inlineCallbacks |
Zsolt Haraszti | adbb88d | 2016-09-12 21:24:57 -0700 | [diff] [blame] | 25 | |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 26 | from structlog_setup import setup_logging |
| 27 | from coordinator import Coordinator |
Zsolt Haraszti | de22bbc | 2016-09-14 15:27:33 -0700 | [diff] [blame] | 28 | from northbound.rest.health_check import init_rest_service |
| 29 | from nethelpers import get_my_primary_interface, get_my_primary_local_ipv4 |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 30 | from dockerhelpers import get_my_containers_name |
| 31 | |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 32 | |
| 33 | defs = dict( |
| 34 | consul=os.environ.get('CONSUL', 'localhost:8500'), |
Zsolt Haraszti | 28e0f1c | 2016-09-13 23:55:43 -0700 | [diff] [blame] | 35 | instance_id=os.environ.get('INSTANCE_ID', os.environ.get('HOSTNAME', '1')), |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 36 | config=os.environ.get('CONFIG', './voltha.yml'), |
Zsolt Haraszti | de22bbc | 2016-09-14 15:27:33 -0700 | [diff] [blame] | 37 | interface=os.environ.get('INTERFACE', get_my_primary_interface()), |
| 38 | internal_host_address=os.environ.get('INTERNAL_HOST_ADDRESS', get_my_primary_local_ipv4()), |
| 39 | external_host_address=os.environ.get('EXTERNAL_HOST_ADDRESS', get_my_primary_local_ipv4()), |
| 40 | fluentd=os.environ.get('FLUENTD', None), |
| 41 | rest_port=os.environ.get('REST_PORT', 8880), |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 42 | ) |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 43 | |
| 44 | |
| 45 | def parse_args(): |
| 46 | |
| 47 | parser = argparse.ArgumentParser() |
| 48 | |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 49 | parser.add_argument('-c', '--config', dest='config', action='store', |
| 50 | default=defs['config'], |
| 51 | help='Path to voltha.yml config file (default: %s). ' |
| 52 | 'If relative, it is relative to main.py of voltha.' % defs['config']) |
| 53 | |
| 54 | parser.add_argument('-C', '--consul', dest='consul', action='store', |
| 55 | default=defs['consul'], |
| 56 | help='<hostname>:<port> to consul agent (default: %s)' % defs['consul']) |
| 57 | |
| 58 | parser.add_argument('-E', '--external-host-address', dest='external_host_address', action='store', |
| 59 | default=defs['external_host_address'], |
| 60 | help='<hostname> or <ip> at which Voltha is reachable from outside the cluster' |
| 61 | '(default: %s)' % defs['external_host_address']) |
| 62 | |
| 63 | parser.add_argument('-F', '--fluentd', dest='fluentd', action='store', |
| 64 | default=defs['fluentd'], |
| 65 | help='<hostname>:<port> to fluentd server (default: %s).' |
| 66 | '(If not specified (None), the address from the config file is used' |
| 67 | % defs['fluentd']) |
| 68 | |
| 69 | parser.add_argument('-H', '--internal-host-address', dest='internal_host_address', action='store', |
| 70 | default=defs['internal_host_address'], |
| 71 | help='<hostname> or <ip> at which Voltha is reachable from inside the cluster' |
| 72 | '(default: %s)' % defs['internal_host_address']) |
| 73 | |
| 74 | parser.add_argument('-i', '--instance-id', dest='instance_id', action='store', |
| 75 | default=defs['instance_id'], |
| 76 | help='unique string id of this voltha instance (default: %s)' % defs['interface']) |
| 77 | |
| 78 | # TODO placeholder, not used yet |
| 79 | parser.add_argument('-I', '--interface', dest='interface', action='store', |
| 80 | default=defs['interface'], |
| 81 | help='ETH interface to send (default: %s)' % defs['interface']) |
| 82 | |
| 83 | parser.add_argument('-n', '--no-banner', dest='no_banner', action='store_true', default=False, |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 84 | help='omit startup banner log lines') |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 85 | |
| 86 | parser.add_argument('-N', '--no-heartbeat', dest='no_heartbeat', action='store_true', default=False, |
| 87 | help='do not emit periodic heartbeat log messages') |
| 88 | |
Zsolt Haraszti | de22bbc | 2016-09-14 15:27:33 -0700 | [diff] [blame] | 89 | parser.add_argument('-R', '--rest-port', dest='rest_port', action='store', type=int, |
| 90 | default=defs['rest_port'], |
| 91 | help='port number for the rest service (default: %d)' % defs['rest_port']) |
| 92 | |
Zsolt Haraszti | 59b7a88 | 2016-09-12 14:42:59 -0700 | [diff] [blame] | 93 | parser.add_argument('-q', '--quiet', dest='quiet', action='store_true', default=False, |
| 94 | help="suppress debug and info logs") |
Zsolt Haraszti | adbb88d | 2016-09-12 21:24:57 -0700 | [diff] [blame] | 95 | |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 96 | parser.add_argument('-v', '--verbose', dest='verbose', action='store_true', default=False, |
| 97 | help='enable verbose logging') |
Zsolt Haraszti | adbb88d | 2016-09-12 21:24:57 -0700 | [diff] [blame] | 98 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 99 | parser.add_argument('--instance-id-is-container-name', dest='instance_id_is_container_name', action='store_true', |
| 100 | default=False, help='use docker container name as voltha instance id' |
| 101 | ' (overrides -i/--instance-id option)') |
| 102 | |
| 103 | args = parser.parse_args() |
| 104 | |
| 105 | # post-processing |
| 106 | |
| 107 | if args.instance_id_is_container_name: |
| 108 | args.instance_id = get_my_containers_name() |
| 109 | |
| 110 | return args |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 111 | |
| 112 | |
Zsolt Haraszti | d7c7c48 | 2016-09-13 00:45:38 -0700 | [diff] [blame] | 113 | def load_config(args): |
| 114 | path = args.config |
| 115 | if path.startswith('.'): |
| 116 | dir = os.path.dirname(os.path.abspath(__file__)) |
| 117 | path = os.path.join(dir, path) |
| 118 | path = os.path.abspath(path) |
| 119 | with open(path) as fd: |
| 120 | config = yaml.load(fd) |
| 121 | return config |
| 122 | |
| 123 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 124 | def print_banner(log): |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 125 | log.info(' _ ______ __ ________ _____ ') |
| 126 | log.info('| | / / __ \/ / /_ __/ / / / |') |
| 127 | log.info('| | / / / / / / / / / /_/ / /| |') |
| 128 | log.info('| |/ / /_/ / /___/ / / __ / ___ |') |
| 129 | log.info('|___/\____/_____/_/ /_/ /_/_/ |_|') |
Zsolt Haraszti | 59b7a88 | 2016-09-12 14:42:59 -0700 | [diff] [blame] | 130 | log.info('(to stop: press Ctrl-C)') |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 131 | |
| 132 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 133 | class Main(object): |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 134 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 135 | def __init__(self): |
| 136 | self.args = args = parse_args() |
| 137 | self.config = load_config(args) |
| 138 | self.log = setup_logging(self.config.get('logging', {}), args.instance_id, fluentd=args.fluentd) |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 139 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 140 | # components |
| 141 | self.coordinator = None |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 142 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 143 | if not args.no_banner: |
| 144 | print_banner(self.log) |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 145 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 146 | if not args.no_heartbeat: |
| 147 | self.start_heartbeat() |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 148 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 149 | self.startup_components() |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 150 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 151 | def start(self): |
| 152 | self.start_reactor() # will not return except Keyboard interrupt |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 153 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 154 | def startup_components(self): |
| 155 | self.log.info('starting-internal-components') |
| 156 | self.coordinator = Coordinator( |
| 157 | internal_host_address=self.args.internal_host_address, |
| 158 | external_host_address=self.args.external_host_address, |
| 159 | rest_port=self.args.rest_port, |
| 160 | instance_id=self.args.instance_id, |
| 161 | consul=self.args.consul) |
| 162 | init_rest_service(self.args.rest_port) |
| 163 | self.log.info('started-internal-services') |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 164 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 165 | @inlineCallbacks |
| 166 | def shutdown_components(self): |
| 167 | """Execute before the reactor is shut down""" |
| 168 | self.log.info('exiting-on-keyboard-interrupt') |
| 169 | yield self.coordinator.shutdown() |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 170 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 171 | def start_reactor(self): |
| 172 | from twisted.internet import reactor |
| 173 | reactor.callWhenRunning(lambda: self.log.info('twisted-reactor-started')) |
| 174 | reactor.addSystemEventTrigger('before', 'shutdown', self.shutdown_components) |
| 175 | reactor.run() |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 176 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 177 | def start_heartbeat(self): |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 178 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 179 | t0 = time.time() |
| 180 | t0s = time.ctime(t0) |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 181 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 182 | def heartbeat(): |
| 183 | self.log.debug(status='up', since=t0s, uptime=time.time() - t0) |
Zsolt Haraszti | f2da1d0 | 2016-09-13 23:21:35 -0700 | [diff] [blame] | 184 | |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 185 | from twisted.internet.task import LoopingCall |
| 186 | lc = LoopingCall(heartbeat) |
| 187 | lc.start(10) |
Zsolt Haraszti | b71c2a0 | 2016-09-12 13:12:07 -0700 | [diff] [blame] | 188 | |
| 189 | |
| 190 | if __name__ == '__main__': |
Zsolt Haraszti | e060a7d | 2016-09-16 11:08:24 -0700 | [diff] [blame^] | 191 | Main().start() |