Project Clearwater Release 1.0

Total Page:16

File Type:pdf, Size:1020Kb

Project Clearwater Release 1.0 Project Clearwater Release 1.0 Apr 17, 2018 Overview 1 Latest Release 3 2 Architecture 5 3 Getting Started 7 4 Looking Deeper 9 5 Getting Source Code 11 6 Contributing 13 7 Help 15 8 License and Acknowledgements 17 8.1 Clearwater Architecture......................................... 17 8.2 Clearwater Tour............................................. 20 8.3 Exploring Clearwater........................................... 23 8.4 Support.................................................. 24 8.5 Troubleshooting and Recovery...................................... 25 8.6 Installation Instructions......................................... 28 8.7 All-in-one Images............................................ 29 8.8 Automated Install Instructions...................................... 31 8.9 Manual Install Instructions........................................ 32 8.10 All-in-one EC2 AMI Installation..................................... 41 8.11 All-in-one OVF Installation....................................... 41 8.12 Installing a Chef server.......................................... 43 8.13 Installing a Chef Client.......................................... 44 8.14 Creating a Chef deployment environment................................ 46 8.15 Creating a deployment with Chef.................................... 49 8.16 Making calls through Clearwater.................................... 51 8.17 Using the Android SIP Client with Clearwater............................. 53 8.18 Using Zoiper with Clearwater...................................... 54 8.19 Configuring Geographic redundancy................................... 55 8.20 Upgrading a Clearwater Deployment.................................. 57 8.21 Modifying Clearwater Settings...................................... 59 8.22 Clearwater Configuration Options Reference.............................. 61 i 8.23 Configuring an Application Server.................................... 73 8.24 External HSS Integration......................................... 76 8.25 OpenIMS HSS Integration........................................ 78 8.26 CDF Integration............................................. 80 8.27 Clearwater IP Port Usage........................................ 81 8.28 Clearwater DNS Usage.......................................... 85 8.29 ENUM Guide............................................... 93 8.30 Voxbone................................................. 100 8.31 SNMP Statistics............................................. 102 8.32 Stateful Statistics............................................. 108 8.33 SNMP Alarms.............................................. 109 8.34 Radius Authentication.......................................... 111 8.35 Application Server Guide........................................ 115 8.36 WebRTC support in Clearwater..................................... 117 8.37 IR.92 Supplementary Services...................................... 119 8.38 Backups................................................. 120 8.39 Call Barring............................................... 126 8.40 Call Diversion.............................................. 127 8.41 Elastic Scaling.............................................. 128 8.42 Privacy.................................................. 130 8.43 Off-net Calling with BGCF and IBCF.................................. 132 8.44 Multiple Domains............................................ 134 8.45 Multiple Network Support........................................ 135 8.46 Geographic redundancy......................................... 138 8.47 IPv6.................................................... 139 8.48 SIP Interface Specifications....................................... 140 8.49 SIP OPTIONS poll support in Clearawater............................... 157 8.50 Clearwater Automatic Clustering and Configuration Sharing...................... 158 8.51 Provisioning Subscribers......................................... 159 8.52 Dealing with Failed Nodes........................................ 161 8.53 Dealing with Multiple Failed Nodes................................... 162 8.54 Dealing with Complete Site Failure................................... 166 8.55 C++ Coding Guidelines......................................... 167 8.56 Ruby Coding Guidelines......................................... 168 8.57 Debugging Clearwater with GDB and Valgrind............................. 172 8.58 Pull Request Process........................................... 173 8.59 Unit tests................................................. 174 8.60 Stress Testing............................................... 176 8.61 Using Cacti with Clearwater....................................... 179 8.62 Running the Clearwater Live Tests.................................... 181 ii Project Clearwater, Release 1.0 Project Clearwater is an open-source IMS core, developed by Metaswitch Networks and released under the GNU GPLv3. You can find more information about it on our website. Overview 1 Project Clearwater, Release 1.0 2 Overview CHAPTER 1 Latest Release The latest release of Clearwater is “Zamîn”. 3 Project Clearwater, Release 1.0 4 Chapter 1. Latest Release CHAPTER 2 Architecture Clearwater is architected from the ground up to be fully horizontally scalable, modular and to support running in virtualized environments. See our Clearwater Architecture page for a bird’s eye view of a Clearwater deployment and a guided tour of the various functional components that comprise it. 5 Project Clearwater, Release 1.0 6 Chapter 2. Architecture CHAPTER 3 Getting Started • Installation Instructions • Making your first call • Running the live tests • A tour of Clearwater 7 Project Clearwater, Release 1.0 8 Chapter 3. Getting Started CHAPTER 4 Looking Deeper To look at the optional extra features and function of your Clearwater deployment and for discussions about Clearwater scaling and redundancy, see Exploring Clearwater. 9 Project Clearwater, Release 1.0 10 Chapter 4. Looking Deeper CHAPTER 5 Getting Source Code All the source code is on GitHub, in the following repositories (and their submodules). • chef- Chef recipes for Clearwater deployment • clearwater-infrastructure - General infrastructure for Clearwater deployments • clearwater-logging - Logging infrastructure for Clearwater deployments • clearwater-live-test - Live test for Clearwater deployments • clearwater-readthedocs - This documentation repository • crest - RESTful HTTP service built on Cassandra - provides Homer (the Clearwater XDMS) and Homestead- prov (the Clearwater provisioning backend) • ellis - Clearwater provisioning server • sprout - Sprout and Bono, the Clearwater SIP router and edge proxy • homestead - Homestead, the Clearwater HSS-cache. • ralf - Ralf, the Clearwater CTF. 11 Project Clearwater, Release 1.0 12 Chapter 5. Getting Source Code CHAPTER 6 Contributing You can contribute by making a GitHub pull request. See our documented Pull request process. If you want to contribute specifically to this documentation (e.g. to fix a typo or document a missing option), the Markdown files for it are at https://github.com/Metaswitch/clearwater-readthedocs. There is more information about contributing to Project Clearwater on the community page of our project website. 13 Project Clearwater, Release 1.0 14 Chapter 6. Contributing CHAPTER 7 Help If you want help, or want to help others by making Clearwater better, see the Support page. 15 Project Clearwater, Release 1.0 16 Chapter 7. Help CHAPTER 8 License and Acknowledgements Clearwater’s license is documented in LICENSE.txt. It uses other open-source components as acknowledged in README.txt. 8.1 Clearwater Architecture Clearwater was designed from the ground up to be optimized for deployment in virtualized and cloud environments. It leans heavily on established design patterns for building and deploying massively scalable web applications, adapting these design patterns to fit the constraints of SIP and IMS. The Clearwater architecture therefore has some similarities to the traditional IMS architecture but is not identical. In particular . • All components are horizontally scalable using simple, stateless load-balancing. • All long lived state is stored on dedicated “Vellum” nodes which make use of cloud-optimized storage technolo- gies such as Cassandra. No long lived state is stored on other production nodes, making it quick and easy to dynamically scale the clusters and minimizing the impact if a node is lost. • Interfaces between the front-end SIP components and the back-end services use RESTful web services inter- faces. • Interfaces between the various components use connection pooling with statistical recycling of connections to ensure load is spread evenly as nodes are added and removed from each layer. The following diagram illustrates the Clearwater architecture and its components. 8.1.1 Bono (Edge Proxy) The Bono nodes form a horizontally scalable SIP edge proxy providing both a SIP IMS Gm compliant interface and a WebRTC interface to clients. Client connections are load balanced across the nodes. The Bono node provides the anchor point for the client’s connection to the Clearwater system, including support for various NAT traversal 17 Project Clearwater, Release 1.0 Fig. 8.1: Architecture mechanisms. A client is therefore anchored to a particular Bono node for the duration of its registration, but can move to another Bono node if the connection or client fails. Clients can connect to Bono using SIP/UDP or SIP/TCP. Bono supports any WebRTC client that performs call setup signaling using SIP
Recommended publications
  • Recent Intellectual Property Representations
    Recent Intellectual Property Representations Patent Litigation RECENT PATENT REPRESENTATIONS Desktop Metal v. Markforged, et al. v. Ricardo Fulop, et al. (D. Mass. 2018). QE’s new Boston office won its first jury trial in July 2018 during phase one of a bet-the-company litigation involving major players in the desktop 3D metal printing market. The case may have set a record for our firm's fastest time to trial ever in a patent suit (11 weeks from initial scheduling conference to trial). At trial, after hearing three weeks of evidence, the jury returned a verdict against Desktop Metal and in favor of our client, Markforged, finding no infringement by Markforged on any of the asserted patents. Markforged also filed counterclaims for trade secret misappropriation, breach of fiduciary duty, and breach of contract, which were tried before another jury during phase two of the litigation in September 2018. We obtained a very favorable (confidential) settlement on behalf of Markforged after opening statements and our CEO taking the stand on direct examination for multiple days. Affinity Labs of Texas LLP v. Netflix, Inc. (PTAB 2018). We were engaged by our client, Netflix, Inc., in two inter partes review proceedings challenging the validity of patents owned by Affinity Labs of Texas, LLC relating to streaming systems for digitally stored audio, video, and textual content. Following the Oral Hearing, the PTAB issued Final Written Decisions in each proceeding finding that all challenged claims were unpatentable. We represent Netflix in an appeal of the PTAB’s ruling that was recently filed by Affinity and is currently pending before the Federal Circuit.
    [Show full text]
  • Commportal V9.5.40 USER GUIDE
    CommPortal User Guide Powered by: Version 9.5.40 CommPortal v9.5.40 USER GUIDE Notices Copyright © 2000-2020 Metaswitch Networks. All rights reserved. This manual is issued on a controlled basis to a specific person on the understanding that no part of the Metaswitch Networks product code or documentation (including this manual) will be copied or distributed without prior agreement in writing from Metaswitch Networks. Metaswitch Networks reserves the right to, without notice, modify or revise all or part of this document and/or change product features or specifications and shall not be responsible for any loss, cost, or damage, including consequential damage, caused by reliance on these materials. Metaswitch and the Metaswitch logo are trademarks of Metaswitch Networks. Other brands and products referenced herein are the trademarks or registered trademarks of their respective holders. 855.216.4334 | www.momentumtelecom.com/support 2 CommPortal v9.5.40 USER GUIDE Contents 1 Introduction.............................................................................................................6 1.1 About This Manual................................................................................................................ 6 1.2 About the CommPortal Screen Shots................................................................................... 7 2 CommPortal Overview...........................................................................................8 2.1 Interface Overview................................................................................................................
    [Show full text]
  • Ipedge Virtual Server Install for R1.7.4 and Later Systems Title Page
    Telecommunication Systems Division IPedge Virtual Server Install For R1.7.4 and Later Systems Title Page Febuary 2017 Publication Information Toshiba America Information Systems, Inc. Telecommunication Systems Division Publication Information Toshiba America Information Systems, Inc., Telecommunication Systems Division, reserves the right, without prior notice, to revise this information publication for any reason, including, but not limited to, utilization of new advances in the state of technical arts or to simply change the design of this document. Further, Toshiba America Information Systems, Inc., Telecommunication Systems Division, also reserves the right, without prior notice, to make such changes in equipment design or components as engineering or manufacturing methods may warrant. Version 2, Febuary 2017 IPedge R1.7.4 and later Our mission to publish accurate, complete and user accessible documentation. At the time of printing the information in this document was as accurate and current as was reasonably possible. However, in the time required to print and distribute this manual additions, corrections or other changes may have been made. To view the latest version of this or other documents please refer to the Toshiba FYI website. Toshiba America Information Systems shall not be liable for any commercial losses, loss of revenues or profits, loss of goodwill, inconvenience, or exemplary, special, incidental, indirect or consequential damages whatsoever, or claims of third parties, regardless of the form of any claim that may result from the use of this document. THE SPECIFICATIONS AND INFORMATION PROVIDED HEREIN ARE FOR INFORMATIONAL PURPOSES ONLY AND ARE NOT A WARRANTY OF ACTUAL PERFORMANCE, WHETHER EXPRESSED OR IMPLIED. THE SPECIFICATIONS AND INFORMATION ARE SUBJECT TO CHANGE WITHOUT NOTICE.
    [Show full text]
  • Online Nation 2021 Report
    Online Nation 2021 report Published 9 June 2021 Welsh version available: Ein Gwlad Ar-lein - Trosolwg Cymraeg Contents Section Overview ............................................................................................................................ 3 What we have found – in brief ........................................................................................................... 3 1. The online consumer ...................................................................................................... 9 Introduction ........................................................................................................................................ 9 Internet take-up and use .................................................................................................................. 11 Device take-up and use ..................................................................................................................... 16 Use of internet services .................................................................................................................... 19 Online harms and attitudes to regulation ........................................................................................ 40 2. Children ........................................................................................................................ 49 Introduction ...................................................................................................................................... 49 Children’s internet take-up
    [Show full text]
  • 5G Catalysts: Telco Cloud and Edge Trends
    Futuriom 5G Catalysts: Telco Cloud and Edge Trends Key Findings and Highlights • $100+B C-band Investment Drives the Real Year of 5G. A9er several years of the “Year of 5G,” Futuriom believes it’s actually happening in 2021. That’s because communicaHons service providers (CSPs) and cloud providers are making real investments for hundreds of billions of dollars in the C-band spectrum to roll out 5G and cloud edge infrastructure to support next-generaHon wireless applicaHons. • Top 5G Edge Services. The most promising applicaHons and use cases for 5G edge cloud that will emerge from edge cloud from 2021-2025 include wireless broadband, streaming media, cloud gaming, connected vehicles, smart anything (Smart X), immersive experiences (VR/AR), MulH-access Edge Compute (MEC) as-a-service, and private wireless networks. • Cloud Ecosystems Are Taking Shape and Will Accelerate in 2021. Public cloud providers have stepped up their partnerships with CSPs and technology plaVorm vendors. Partnerships among cloud providers, CSPs, and datacenter providers are starHng to accelerate. • Cloud Players Are SPll Favored for Edge. Cloud service providers sHll have the strategic edge and leverage in providing cloud services ranging from IIoT to cloud gaming. In order to gain market share, CSPs need to focus their moneHzaHon strategies in balance with the right cloud provider partnerships to avoid “dump pipe” strategies. • Architecture Catalysts. The arrival of 5G will serve as a catalyst to accelerate network architectures built on technologies such as virtualizaHon and microservices. This will benefit providers of so9ware virtualizaHon technology and experHse from the cloud, as well as technology vendors focused on service automaHon, security, and cloud-naHve architectures.
    [Show full text]
  • Online Nation 2021 Report
    Online Nation 2021 report Published 9 June 2021 Welsh version available: Ein Gwlad Ar-lein - Trosolwg Cymraeg Contents Section Overview ............................................................................................................................ 3 What we have found – in brief ........................................................................................................... 3 1. The online consumer ...................................................................................................... 9 Introduction ........................................................................................................................................ 9 Internet take-up and use .................................................................................................................. 11 Device take-up and use ..................................................................................................................... 16 Use of internet services .................................................................................................................... 19 Online harms and attitudes to regulation ........................................................................................ 40 2. Children ........................................................................................................................ 49 Introduction ...................................................................................................................................... 49 Children’s internet take-up
    [Show full text]
  • Pop Virtualization
    POP VIRTUALIZATION FROM CONCEPT TO REALITY IPX What customers think and want May 2013 Table of Contents INTRODUCTION 3 KEY MESSAGES 3 DRIVERS FOR VIRTUALIZATION 4 VIRTUALIZATION WHAT, WHY, HOW 7 POP VIRTUALIZATION 12 NETWORK DEPLOYMENT – NOW 13 CLOUD ENVIRONMENTS 15 NETWORK DEPLOYMENT – IN THE VIRTUALIZATION ERA 17 POP VIRTUALIZATION – IMPLEMENTATION STRATEGIES 19 FROM CONCEPT TO REALITY 23 METASWITCH’S VIRTUALIZED SBC – PERIMETA 24 CONCLUSIONS 25 ABOUT US 27 POP VIRTUALIZATION │ 2 INTRODUCTION KEY MESSAGES Change is perhaps the only thing that doesn’t change in the international carrier world! This is especially true with wholesale voice. Over the years, the industry has absorbed, with varied levels Operators are crippled when it comes to reacting of success, a number of assaults or waves of evolution. First came to today’s rapidly evolving customers’ needs the decline of the bilateral world, followed by the rise of Voice over IP, which brought new breeds of competitors and then enabled the Network Functions Virtualization (NFV) will be a rise of communications apps such as Skype and WhatsApp. Add key enabler for wholesalers to meet the new to this the constantly falling termination prices. Is there no end to business challenges of quality, global reach, the threats to this industry? efficiency, nimbleness and cost control Now comes another seismic change over the horizon: the rise of The clear drive in NFV with SDN is to first separate virtualization. Most wholesale carriers are aware of the growth of the control and data layers, automate operational cloud computing and the impact of that on IT operations in particular.
    [Show full text]
  • Tales from the Fiber Frontier
    TalesTales FromFrom thethe FiberFiber FrontierFrontier Schools and businesses, online gamers and television viewers, small towns and big cities all have reasons to welcome fiber optic access. By Masha Zager ■ Broadband Properties ome months, one story says it all. This time it was needs an instantaneous response. Now. If the message takes the private school outside Salisbury, N.C., that peti- too long to arrive, the trade doesn’t go through and profits Stioned the city to annex its property. Why? Salisbury evaporate. How can a company guarantee an instantaneous is building a municipal fiber-to-the-premises network that response every time? Sign up with a business fiber provider the school didn’t wanted to miss out on. School adminis- – in this case, Optimum Lightpath. trators are developing a technology-enhanced learning pro- There’s also the regional provider whose network is keep- gram for their students, and they knew a fiber connection ing remote towns in South Dakota viable. And the Florida would make the program even better. The city’s response: condo communities that are being upgraded with world- Come on board – we’re delighted to have you. class broadband. And the new services Verizon is introduc- Running a close second is the story of the financial com- ing for FiOS subscribers. And … well, you’ll have to read pany in New York that operates a foreign-exchange trading the rest. I’m not going to give it all away. platform. It turns out that trading currencies is a lot like playing video games: When a trader hits the Enter key, he – MZ INDEPENDENT TELCOS ‘Internet Traffic Is Increasingly Two-Way’ Northeast Missouri Rural Telephone downstream bandwidth is important using FTTH solutions from Occam in Green City, Mo., is upgrading the sec- too – it enables the IPTV service that Networks.
    [Show full text]
  • Verizon Fios®, the Most Advanced TV, Internet and Phone Service Available
    Connect With These Top Companies Visit their booths or ask the BBP staff in the Expo Hall to provide an introduction. Booth #341 http://communities.verizon.com/ $)XUXNDZD&RPSDQ\ Booth #315 www.att.com/communities Booth #614 www.connexiontechnologies.net www.timewarnercable.com Booth #641 www.wileyrein.com Booth #633 Booth #909 www.gatelsupply.com Booth #501 Booth #605 Booth #409 Booth #815 Booth #623 Booth #333 Booth #221 www.amt.com Booth #415 Booth #402 Don’t miss the all-new bonus pages in our upcoming Digital editions Get valuable added editorial in our digital issue BONUS sections. Extra articles • Charts • Maps • Graphs • Statistics FOR A LIMITED TIME, Search each issue and across all issues. qualified subscribers can sign up for both print Save time by clicking on links to ads. and digital editions and continue to receive both articles to colleagues with one click. Send at no charge. Click through the pages with ease — much better than a PDF. Go to www.bbpmag.com/subscribe and START or RENEW your subscription now. Select either DIGITAL or BOTH PRINT AND DIGITAL. Do you have the bandwidth to attract and keep residents? Broadband at the speed of fi ber-optic light. Streaming video and interactive gaming that defy description. The coolest programming, and more of it, on the purity of HDTV. Pure joy. This is what today’s residents demand. And this is what you can give them with Verizon FiOS®, the most advanced TV, Internet and phone service available. Set up by our own experts, who will create a custom installation plan just for you.
    [Show full text]
  • UK Technology M&A Review
    1 UK Technology M&A Review January 2021 GLOBAL TECH BANKING 2 3 • The strangest of years but massive Contents government stimulus in response to COVID-19 – whatever it takes Key • Interest rates fell to record lows and 3 Key Findings squeezed valuations even higher • Wave of cheap money fuelling strong Findings 6 Highlights equity markets -NASDAQ up 43% last year. FANG+ doubled 10 UK Technology M&A • Retail investors created bubbles in • Overseas buyers are still key in UK, 13 FinTech the likes of Bitcoin, Tesla and US and accounted for a record 48% of Cloud software IPOs deals in 2020 14 Legal & Compliance • Lots of UK Technology M&A activity, • Consolidation in Payments, Logistics, 15 Property Related over 700 deals. Q4 was up 6% YoY – Legal, Property, Education and digital near record volume transformation 17 Transport & Logistics • UK valuations rose again, 5x • Busiest acquirers in UK in 2020 were 19 Hardware revenues is increasingly common PE backed – such as Advanced, 19 Cybersecurity Access, Clearcourse but also included new buyers from Australia 21 IOT/AI & Machine Learning and Scandinavia 22 EdTech NASDAQ - WHAT CRISIS? • We have a vaccine, Donald has gone, Brexit is behind us – what can 23 Human Capital Management Tech possibly go wrong? 24 Cloud Software 13.5k 25 Information Management 12.5k 26 eCommerce 27 Communications 11.5k 30 ICT Managed Services 33 Computer Games 10.5k 34 Risers & Fallers 9.5k 36 US Technology M&A 8.5k 40 Alternatives – IPOs & Private Equity 7.5k 44 ICON Selected Deals 6.5k 5.5k 1/19 4/19 7/19 10/19 1/20 4/20 7/20 10/20 1/21 TECH M&A REVIEW v 4 5 No.
    [Show full text]
  • Iot: the Internet of Talk the Future of Voice Communications
    IoT: The Internet of Talk The Future of Voice Communications INTRODUCTION Telephony is the lifeblood of the telecom industry. But The challenge for the telecom industry is to bolster and that blood has been getting thinner in recent years, as reinvigorate its voice services, not just switch over the alternative modes of communication, as well as Internet- infrastructure to IP – although if this can lower costs or based providers of basic calling-type services, have grown release spectrum it will be welcome. The update will at the expense of ordinary phone minutes. involve many approaches. In part, it involves improving and extending normal “calls,” including using core telephony And while mobile telephony has extended communications systems as platforms for developers and telcos’ internal to billions around the world, it has recently faced an innovators. It will also involve non-traditional voice additional challenge. The arrival of 4G and all-IP connectivity applications for both consumers and enterprise, such as has prompted a replacement of legacy circuit-telephony better push-to-talk systems for field workers, or new forms infrastructure with VoIP, and specifically VoLTE. This has of “social voice” (and often integrated video) for teenagers. been a complex transition and is still ongoing. New pricing models have tended to mean bundling of “unlimited” minutes or large bundles – but there may be But simply replacing old phone networks with newer IP- new approaches for added-value capabilities in future too. based ones is not enough. METASWITCH NETWORKS WWW.METASWITCH.COM But perhaps above all, it will mean blending voice There was no service provider involved, just a wire with contextual and analytical data, to improve the owned by Bell.
    [Show full text]
  • Iamicrosofta2020ieng.Pdf
    Dear shareholders, colleagues, customers, and partners: While the start of a new decade typically brings hope, we quickly saw the world come to a near standstill in 2020, confronted by compounding crises: a public health and economic crisis, persistent issues of systemic racial injustice and inequity, and the devastating effects of climate change. It is easy to fall prey to pessimism, or the sense that we individually or as a company can’t make a difference. But helplessness is corrosive to hope, and hope plus work is what is required. Amid this disruption, what’s clear is that we have a once-in-a-generation opportunity to harness digital technology to define the world we want to live in. And for that, I am optimistic. It is in times like these that our ability to stay true to Microsoft’s mission and corporate purpose is of the utmost importance. As a company, we are steadfast in our mission to empower every person and every organization on the planet to achieve more. Our mission is enduring. It drives who we are and everything we do, emphasizing our passion to empower both people and the lasting institutions they build. And it means we must always use technology to help address the world’s challenges, not create new ones. I’m proud of how our ecosystem of customers and partners has stepped up over the past year to help people and organizations in every country use technology to be resilient and transform during the most trying of circumstances. We’ve acted as digital first responders to the world’s first responders, supporting those on the front lines, from healthcare, to education, to public sector, to critical manufacturing, grocery, and retail.
    [Show full text]