servicecomb-service-center

README

Apache-ServiceComb-Service-Center

Apache ServiceComb Service-Center is a Restful based service-registry that provides micro-services discovery and micro-service management. It is based on Open API format and provides features like service-discovery, fault-tolerance, dynamic routing, notify subscription and scalable by design. It has high performance cache design and separate entity management for micro-services and their instances. It provides out of box support for metrics and tracing. It has a web portal to manage the micro-services.

Components

• server: a http server which provide restful API
• scctl: CLI of server
• syncer: alpha feature. multiple cluster synchronization tool, designed for large microservice architectures

Features

• Open API: API doc(Open API format) management for microservice
• Metadata: Metadata management for both microservice and microservice instance
• Separated: Separated microservice and microservice instance entity management
• Domains: Logical multiple domains management
• Security: White and black list configuration for service discovery
• Discovery: Support query instance by criteria
• Subscribe: Use web socket to notify client about instance change events
• Portal: Awesome web portal
• Fault tolerance: Multiple fault tolerance mechanism and design in the architecture
• Performance: Performance/Caching design
• Metrics: Able to expose Prometheus metric API automatically
• Tracing: Able to report tracing data to Zipkin server
• Pluginable: Able to load custom authentication, tls and other dynamic libraries
• CLI: Easy to control service center
• Kubernetes: Embrace kubernetes ecosystem and support multi cluster service discovery
• Datacenters: Additional layer of abstraction to clusters deployed in multiple datacenters
• Aggregation: Able to aggregate microservices from multiple registry platforms and support platform registry and client side registry at the same time

Documentation

Project documentation is available on the ServiceComb website. You can also find full document here.

Quick Start

Getting Service Center

The easiest way to get Service Center is to use one of the pre-built release binaries which are available for Linux, Windows and Docker.

Running Service Center using the Release

You can download our latest release from ServiceComb Website.When you get these release, you can execute the start script to run Service Center.

Windows(apache-servicecomb-service-center-XXX-windows-amd64.zip):

start-service-center.bat

Linux(apache-servicecomb-service-center-XXXX-linux-amd64.tar.gz):

./start-service-center.sh

Docker:

docker pull servicecomb/service-center
docker run -d -p 30100:30100 servicecomb/service-center

Note: The Releases of Service-Center uses emebeded etcd, if you want to use the seperate instance of etcd then you can deploy the etcd seperately and configure the etcd ip over here.

vi conf/app.conf

## Edit this file
# registry address
# 1. if registry_plugin equals to 'embeded_etcd'
# manager_name = "sc-0"
# manager_addr = "http://127.0.0.1:2380"
# manager_cluster = "sc-0=http://127.0.0.1:2380"
# 2. if registry_plugin equals to 'etcd'
# manager_cluster = "127.0.0.1:2379"
manager_cluster = "127.0.0.1:2379"

By default the SC comes up on 127.0.0.1:30100, however you can change the configuration of these address over here.

vi conf/app.conf

httpaddr = 127.0.0.1
httpport = 30100

Building & Running Service-Center from source

Requirements

• Go version 1.8+ is required to build the latest version of Service-Center.

Download the Code

git clone https://github.com/apache/servicecomb-service-center.git $GOPATH/src/github.com/apache/servicecomb-service-center
cd $GOPATH/src/github.com/apache/servicecomb-service-center

Dependencies

you can download dependencies directly using command go mod. Please follow below steps to download all the dependency.

# skip the checksum verifying if you use the private proxy
export GOSUMDB=off

# Download the modules
GO111MODULE=on go mod download
GO111MODULE=on go mod vendor

Build the Service-Center

go build -o service-center github.com/apache/servicecomb-service-center/cmd/scserver

First, you need to run a etcd(version: 3.x) as a database service and then modify the etcd IP and port in the Service Center configuration file (./etc/conf/app.conf : manager_cluster).

wget https://github.com/coreos/etcd/releases/download/v3.1.8/etcd-v3.1.8-linux-amd64.tar.gz
tar -xvf etcd-v3.1.8-linux-amd64.tar.gz
cd etcd-v3.1.8-linux-amd64
./etcd

cd servicecomb-service-center
cp -r ./etc/conf .
./service-center

This will bring up Service Center listening on ip/port 127.0.0.1:30100 for service communication.If you want to change the listening ip/port, you can modify it in the Service Center configuration file (./conf/app.conf : httpaddr,httpport).

Build docker image

sudo bash scripts/docker/build-image/build.sh

it builds a image servicecomb/service-center

Running Frontend using the Release

You can download our latest release from ServiceComb Website and then untar it and run start-frontend.sh/start-frontend.bat. This will bring up the Service-Center UI on http://127.0.0.1:30103.

Windows(apache-servicecomb-service-center-XXX-windows-amd64.zip):

start-frontend.bat

Linux(apache-servicecomb-service-center-XXXX-linux-amd64.tar.gz):

./start-frontend.sh

Note: By default frontend runs on 127.0.0.1, if you want to change this then you can change it in conf/app.conf.

frontend_host_ip=127.0.0.1
frontend_host_port=30103

You can follow the guide over here to run the Frontend from source.

Get The Latest Release

Download Service Center

Contact

Bugs: issues

Contributing

See Contribution guide for details on submitting patches and the contribution workflow.

Reporting Issues

See reporting bugs for details about reporting any issues.

License

Licensed under an Apache 2.0 license.

Export Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The Apache Software Foundation has classified this software as Export Commodity Control Number (ECCN) 5D002, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the "publicly available" Section 742.15(b) exemption (see the BIS Export Administration Regulations, Section 742.15(b)) for both object code and source code.

The following provides more details on the included cryptographic software:

• golang crypto https://github.com/golang/go/tree/master/src/crypto
• The transport between server and client can be configured to use TLS