blob: b4a8305d6388787e027279ef565ec5ff8d1b3afb [file] [log] [blame]
<!doctype html>
<!--
Minimal Mistakes Jekyll Theme 4.4.1 by Michael Rose
Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
Free for personal and commercial use under the MIT license
https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt
-->
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<!-- begin SEO -->
<title>Registration&amp;Discovery - Apache ServiceComb</title>
<meta name="description" content="Registration and discovery of the service-center">
<meta name="author" content="">
<meta property="og:locale" content="en">
<meta property="og:site_name" content="Apache ServiceComb">
<meta property="og:title" content="Registration&amp;Discovery">
<link rel="canonical" href="https://github.com/pages/apache/incubator-servicecomb-website/docs/products/service-center/registration-discovery/">
<meta property="og:url" content="https://github.com/pages/apache/incubator-servicecomb-website/docs/products/service-center/registration-discovery/">
<meta property="og:description" content="Registration and discovery of the service-center">
<meta name="twitter:site" content="@ServiceComb">
<meta name="twitter:title" content="Registration&amp;Discovery">
<meta name="twitter:description" content="Registration and discovery of the service-center">
<meta name="twitter:url" content="">
<meta name="twitter:card" content="summary">
<script type="application/ld+json">
{
"@context" : "http://schema.org",
"@type" : "Person",
"name" : "Apache ServiceComb",
"url" : "https://github.com/pages/apache/incubator-servicecomb-website",
"sameAs" : null
}
</script>
<meta name="google-site-verification" content="HvJjNd7vvJ-yjSTHlBiIWEYxp_Hrz-PYEY5Idz9LRcA" />
<!-- end SEO -->
<link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache ServiceComb Feed">
<!-- http://t.co/dKP3o1e -->
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script>
document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js ';
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
<script src="/assets/vendor/prism/prism.js"></script>
<script type="text/javascript" async
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">
<script src="https://www.apachecon.com/event-images/snippet.js"></script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js" integrity="sha384-b/U6ypiBEHpOf/4+1nzFpr53nxSS+GLCkfwBdFNTxtclqqenISfwAzpKaMNFNmj4" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/js/bootstrap.min.js" integrity="sha384-h0AbiXch4ZDo7tp9hKZ4TsHbi047NrKGLO3SEJAg45jXxnGIfYzk4Si90RDIqNm1" crossorigin="anonymous"></script>
<!-- For all browsers -->
<link rel="stylesheet" href="/assets/css/main.css">
<link rel="stylesheet" href="/assets/vendor/prism/prism.css">
<!--[if lte IE 9]>
<style>
/* old IE unsupported flexbox fixes */
.greedy-nav .site-title {
padding-right: 3em;
}
.greedy-nav button {
position: absolute;
top: 0;
right: 0;
height: 100%;
}
</style>
<![endif]-->
<meta http-equiv="cleartype" content="on">
<!-- start custom head snippets -->
<!-- insert favicons. use http://realfavicongenerator.net/ -->
<link href="https://fonts.loli.net/css?family=Roboto:400,500,700|Source+Code+Pro" rel="stylesheet">
<script src="/assets/js/custom.js"></script>
<!-- end custom head snippets -->
</head>
<body class="layout--single">
<!--[if lt IE 9]>
<div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</div>
<![endif]-->
<div class="masthead" onmouseleave="$('#childrenShow').css('display', 'none')">
<div class="masthead__inner-wrap">
<div class="masthead__menu">
<nav id="site-nav" class="greedy-nav">
<a class="site-title active" href="/"><img src="https://www.apache.org/img/servicecomb.png"></a>
<ul class="visible-links">
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/">Home</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/developers/">Projects</a>
</li>
<li class="def-nav-li" onmouseenter="$('#childrenShow').css('display', 'block')">
<a href="/docs/users/">Documentation</a>
<ul id="childrenShow" class="def-children-show-en" onmouseleave="$('#childrenShow').css('display', 'none')">
<li><a href="/docs/getting-started/" class="">Getting started</a></li>
<li><a href="/docs/users/" class="">Docs</a></li>
<li><a href="/slides/" class="">Video</a></li>
<li><a href="/faqs/" class="">FAQ</a></li>
</ul>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/year-archive/">Blogs</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/release/">Downloads</a>
</li>
</ul>
<button><div class="navicon"></div></button>
<ul class="hidden-links hidden"></ul>
<div class="nav-lang">
<a href=/cn/docs/products/service-center/registration-discovery/>中文</a>
</div>
</nav>
</div>
</div>
</div>
<div id="main" role="main">
<div class="sidebar sticky">
<div class="back-to-home"><a href="/">Home</a> > Registration&Discovery</div>
<nav class="nav__list">
<input id="ac-toc" name="accordion-toc" type="checkbox" />
<label for="ac-toc">Toggle Menu</label>
<ul class="nav__items">
<li>
<a href="/docs/getting-started/"><span class="nav__sub-title nav__sub-title-with-url">Getting Started</span></a>
</li>
<li>
<a href="/docs/introduction/"><span class="nav__sub-title nav__sub-title-with-url">Introduction</span></a>
</li>
<li>
<span class="nav__sub-title">Service Center</span>
<ul>
<li><a href="/docs/products/service-center/install/" class="">Install</a></li>
<li><a href="/docs/products/service-center/registration-discovery/" class="active">Registration&Discovery</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Java Chassis</span>
<ul>
<li><a href="/docs/products/java-chassis/quick-start/" class="">getting started</a></li>
<li><a href="/docs/products/java-chassis/bmi/" class="">Develop microservice application in minutes</a></li>
<li><a href="/docs/products/java-chassis/advance/" class="">Advance microservice development</a></li>
<li><a href="/docs/products/java-chassis/load-balance/" class="">Load Balance</a></li>
<li><a href="/docs/products/java-chassis/flow-control/" class="">Flow Control</a></li>
<li><a href="/docs/products/java-chassis/service-management/" class="">Service Management</a></li>
<li><a href="/docs/products/java-chassis/distributed-tracing/" class="">Distributed Tracing</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Mesher</span>
<ul>
<li><a href="/docs/products/mesher/quick-start/" class="">getting started</a></li>
<li><a href="/docs/products/mesher/advance/" class="">mesher Advance</a></li>
<li><a href="/docs/products/mesher/load-balance/" class="">mesher balance</a></li>
<li><a href="/docs/products/mesher/flow-control/" class="">mesher Flow Control</a></li>
<li><a href="/docs/products/mesher/service-management/" class="">mesher Service Management</a></li>
<li><a href="/docs/products/mesher/distributed-tracing/" class="">mesher Distributed Tracing</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Toolkit</span>
<ul>
<li><a href="/docs/products/toolkit/quick-start/" class="">Quick Start</a></li>
<li><a href="/docs/products/toolkit/oas-validator/" class="">OpenAPI V3 Spec validation tools</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Syncer</span>
<ul>
<li><a href="/docs/products/syncer/quick-start/" class="">Quick Start</a></li>
<li><a href="/docs/products/syncer/multi-servicecenters/" class="">Different service centers communicate with each other</a></li>
</ul>
</li>
</ul>
</nav>
</div>
<article class="page" itemscope itemtype="http://schema.org/CreativeWork">
<meta itemprop="headline" content="Registration&amp;Discovery">
<meta itemprop="description" content="Registration and discovery of the service-center">
<meta itemprop="dateModified" content="November 12, 2019">
<div class="page__inner-wrap">
<header>
<h1 class="page__title" itemprop="headline">Registration&amp;Discovery
</h1>
</header>
<section class="page__content" itemprop="text">
<aside class="sidebar__right">
<nav class="toc">
<!-- <header><h4 class="nav__title"><i class="fa fa-file-text"></i> On This Page</h4></header> -->
<ul class="toc__menu" id="markdown-toc">
<li><a href="#registrationdiscovery" id="markdown-toc-registrationdiscovery">Registration&amp;Discovery</a></li>
<li><a href="#registration-and-discovery-process" id="markdown-toc-registration-and-discovery-process">Registration and discovery process</a></li>
<li><a href="#first-used-of-registration-and-discovery" id="markdown-toc-first-used-of-registration-and-discovery">First used of registration and discovery</a></li>
</ul>
</nav>
</aside>
<h2 id="registrationdiscovery">Registration&amp;Discovery</h2>
<p>In a microservices architecture, an application consists of a set of services with a single responsibility, and each service is dynamically deployed to a different node. How should we manage the dependencies between this set of services?
<img src="/assets/images/docs/service-center/service-center-why.png" alt="1" /> <br />
The service registry has solved this problem. It allows the service of provider to register its information to the service-center; the service of consumer can discover the provider information from the service-center.
The service registry has several advantages:</p>
<ul>
<li>1 Decouple the provider and the consumer, the service consumer does not need to know the provider address;</li>
<li>2 Service dynamic discovery and scalability, dynamic changes of the instance of provider will be pushed to the consumer with the service-center;</li>
<li>3 You can monitor the quality of service operations and service dependencies dynamically, and provide governance capabilities for services.</li>
</ul>
<h2 id="registration-and-discovery-process">Registration and discovery process</h2>
<p><img src="/assets/images/docs/service-center/registration&amp;discovery.png" alt="1" /><br />
The service registration and discovery process in Service-Center has the following steps:</p>
<ul>
<li>1 Registration the provider service to Service-Center.</li>
<li>2 The provider sends a heartbeat to maintain the “UP” state in Service-Center.</li>
<li>3 Registration the consumer service to Service-Center.</li>
<li>4 The Consumer discover the provider information from Service-Center.</li>
<li>5 The consumer request the provider and get results.</li>
</ul>
<p>The Service-Center registration and discovery interface is implemented based on the RESTful standard. It is not restricted by the development language. For the interface definition, please refer to <a href="https://rawcdn.githack.com/ServiceComb/service-center/master/docs/api-docs.html">API Document</a></p>
<h2 id="first-used-of-registration-and-discovery">First used of registration and discovery</h2>
<p>This chapter is about how to implement the feature of micro-service discovery with ServiceCenter.</p>
<ol>
<li>Registration the provider service
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-X</span> POST <span class="se">\</span>
http://127.0.0.1:30100/registry/v3/microservices <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'content-type: application/json'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'x-domain-name: default'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'{
"service":
{
"appId": "default",
"serviceName": "ProviderDemoService",
"version":"1.0.0"
}
}'</span>
</code></pre></div> </div>
<p>And then you can get the ‘ProviderDemoService’ ID like below:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">{</span><span class="s2">"serviceId"</span>:<span class="s2">"fa82132706a6b75a13393d8cf48800f9689b2603"</span><span class="o">}</span>
</code></pre></div> </div>
</li>
<li>Registration the provider instance<br />
Mark down the micro-service ID and call the instance registration API, according to the ServiceCenter definition: One process should be registered as one instance.
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-X</span> POST <span class="se">\</span>
http://127.0.0.1:30100/registry/v3/microservices/fa82132706a6b75a13393d8cf48800f9689b2603/instances <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'content-type: application/json'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'x-domain-name: default'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'{
"instance":
{
"hostName":"provider-demo",
"endpoints": [
"rest://127.0.0.1:8080"
]
}
}'</span>
</code></pre></div> </div>
<p>The successful response like below:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">{</span><span class="s2">"instanceId"</span>:<span class="s2">"6e160fb0196e11e9b8b50242ac110005"</span><span class="o">}</span>
</code></pre></div> </div>
</li>
<li>Registration the consumer service
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-X</span> POST <span class="se">\</span>
http://127.0.0.1:30100/registry/v3/microservices <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'content-type: application/json'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'x-domain-name: default'</span> <span class="se">\</span>
<span class="nt">-d</span> <span class="s1">'{
"service":
{
"appId": "default",
"serviceName": "ConsumerDemoService",
"version":"1.0.0"
}
}'</span>
</code></pre></div> </div>
<p>if all are successful, it means you have completed the micro-service registration and instance publish</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">{</span><span class="s2">"serviceId"</span>:<span class="s2">"d08d29edbeaa372c5be88407aa9adb00b4cb6099"</span><span class="o">}</span>
</code></pre></div> </div>
</li>
<li>Discovery the provider<br />
The next step is that discovery the micro-service instance by service name and version rule
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-X</span> GET <span class="se">\</span>
<span class="s1">'http://127.0.0.1:30100/registry/v3/instances?appId=default&amp;serviceName=ProviderDemoService&amp;version=latest'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'content-type: application/json'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'x-consumerid: d08d29edbeaa372c5be88407aa9adb00b4cb6099'</span> <span class="se">\</span>
<span class="nt">-H</span> <span class="s1">'x-domain-name: default'</span>
<span class="o">{</span>
<span class="s2">"instances"</span>: <span class="o">[</span>
<span class="o">{</span>
<span class="s2">"instanceId"</span>: <span class="s2">"c23da577197111e9b8b50242ac110005"</span>,
<span class="s2">"serviceId"</span>: <span class="s2">"fa82132706a6b75a13393d8cf48800f9689b2603"</span>,
<span class="s2">"endpoints"</span>: <span class="o">[</span>
<span class="s2">"rest://127.0.0.1:8080"</span>
<span class="o">]</span>,
<span class="s2">"hostName"</span>: <span class="s2">"provider-demo"</span>,
<span class="s2">"status"</span>: <span class="s2">"UP"</span>,
<span class="s2">"healthCheck"</span>: <span class="o">{</span>
<span class="s2">"mode"</span>: <span class="s2">"push"</span>,
<span class="s2">"interval"</span>: 30,
<span class="s2">"times"</span>: 3
<span class="o">}</span>,
<span class="s2">"timestamp"</span>: <span class="s2">"1547631199"</span>,
<span class="s2">"modTimestamp"</span>: <span class="s2">"1547631199"</span>,
<span class="s2">"version"</span>: <span class="s2">"1.0.0"</span>
<span class="o">}</span>
<span class="o">]</span>
<span class="o">}</span>
</code></pre></div> </div>
</li>
</ol>
</section>
<footer class="page__meta">
</footer>
</div>
</article>
</div>
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<div align="center" style="margin: 0 0;">
<ins class="adsbygoogle"
style="display:block; border-bottom: initial;"
data-ad-client="ca-pub-7328585512091257"
data-ad-slot="3049671934"
data-ad-format="auto"></ins>
</div>
<div class="page__footer">
<footer>
<!-- start custom footer snippets -->
<!-- end custom footer snippets -->
<div class="container">
<div class="row justify-content-md-center">
<div class="col">
<ul>
<p class="header">Events</p>
<a class="acevent" data-format="square" data-mode="dark" data-event="random"></a>
</ul>
</div>
<div class="col">
<ul>
<p class="header">Resources</p>
<li><a href="/docs/getting-started/">Getting started</a></li>
<li><a href="/docs/users/">User Guide</a></li>
<li><a href="/slides/">Slides</a></li>
<li><a href="/users/faq/">Common Questions</a></li>
</ul>
</div>
<div class="col">
<ul>
<p class="header">ASF</p>
<li><a href="http://www.apache.org">Foundation</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="http://www.apache.org/events/current-event">Events</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
</ul>
</div>
<div class="col">
<ul>
<p class="header">Contribute</p>
<li><a href="http://issues.apache.org/jira/browse/SCB">Report a Doc Issue</a></li>
<li><a href="https://github.com/apache/servicecomb-website/edit/master/_docs/products/service-center/registration-discovery.md">Edit This Page on Github</a></li>
<li><a href="/developers/submit-codes/">Code Submit Guide</a></li>
<li><a href="/security">Security</a></li>
</ul>
</div>
<div class="col">
<ul class="social-icons">
<p class="header">Community</p>
<li>
<a href="mailto:dev-subscribe@servicecomb.incubator.apache.org" rel="nofollow"><span class="mail">Mailing List</span></a>
</li>
<li>
<a href="https://github.com/apache?q=ServiceComb" target="_blank"><span class="github">Github</span></a>
</li>
<li>
<a href="https://twitter.com/ServiceComb" target="_blank"><span class="twitter">Twitter</span></a>
</li>
<li>
<a href="/feed.xml" target="_blank"><span class="rss">Feed</span></a>
</li>
</ul>
</div>
</div>
</div>
<div class="page__footer-bottom">
<div>&copy; 2024 Apache ServiceComb. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> &amp; <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</div>
<div>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
</footer>
</div>
<script src="/assets/js/main.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-101622733-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>