# PolarisMesh

**Repository Path**: plutusr/PolarisMesh

## Basic Information

- **Project Name**: PolarisMesh
- **Description**: 北极星（Polaris Mesh）是腾讯自研的服务发现和治理中心，以服务注册中心为基础，扩展了服务治理功能以及相应的控制面，解决分布式和微服务架构中的服务可见、故障容错、流量控制和
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/polarismesh
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 19
- **Created**: 2021-09-12
- **Last Updated**: 2024-06-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 北极星：服务发现和治理

<img src="logo.svg" width="10%" height="10%" />

[English](./README.md) | 简体中文

---

README：

- [介绍](#介绍)
- [项目构成](#项目构成)
- [快速入门](#快速入门)
- [交流群](#交流群)
- [参与贡献](#参与贡献)

其他文档请见[北极星官网](https://polarismesh.cn)

## 介绍

北极星是一个支持多语言、多框架的云原生服务发现和治理中心，解决分布式和微服务架构中的服务可见、故障容错、流量控制和安全问题。

功能：

- 基础功能：服务发现、服务注册、健康检查
- 故障容错：熔断降级、访问限流
- 流量控制：动态路由、负载均衡
- 安全：访问鉴权

特色：

- 北极星的功能采用插件化的形式实现，业务可以根据需求选择使用，也非常容易实现扩展
- 提供SDK和Sidecar两种接入方式，SDK适用于高性能的业务场景，Sidecar适用于无侵入的开发模式
- 对于SDK的接入方式，提供Java、Go、C++和NodeJS等多种语言的客户端，功能实现相同
- 北极星SDK可以集成到常用的框架和网关中，例如Spring Cloud、gRPC和Nginx
- 适用于Kubernetes，支持K8s service和Polaris sidecar的自动注入
- 腾讯百万级服务治理中心的开源版本，沉淀了腾讯多年的分布式服务治理经验

## 项目构成

服务端:

- [polaris](https://github.com/PolarisMesh/polaris): 控制面
- [polaris-console](https://github.com/PolarisMesh/polaris-console): 控制台

客户端:

- [polaris-java](https://github.com/PolarisMesh/polaris-java): Java客户端
- [polaris-go](https://github.com/PolarisMesh/polaris-go): Go客户端
- [polaris-cpp](https://github.com/PolarisMesh/polaris-cpp): C++客户端
- [polaris-nodejs](https://github.com/PolarisMesh/polaris-nodejs): NodeJS客户端
- [polaris-sidecar](https://github.com/PolarisMesh/polaris-sidecar): 基于Envoy的Sidecar

生态组件:

- [polaris-controller](https://github.com/PolarisMesh/polaris-controller): K8s控制器，支持K8s Service和Polaris Sidecar自动注入
- [spring-cloud-polaris](https://github.com/PolarisMesh/spring-cloud-polaris): spring cloud集成polaris-java
- [grpc-java-polaris](https://github.com/PolarisMesh/grpc-java-polaris): grpc-java集成polaris-java
- [grpc-go-polaris](https://github.com/PolarisMesh/grpc-go-polaris): grpc-go集成polaris-go
- [grpc-cpp-polaris](https://github.com/PolarisMesh/grpc-cpp-polaris): grpc集成polaris-cpp
- [grpc-nodejs-polaris](https://github.com/PolarisMesh/grpc-nodejs-polaris): grpc-node集成polaris-nodejs
- [nginx-polaris](https://github.com/PolarisMesh/nginx-polaris): nginx集成polaris-cpp

其他:

- [website](https://github.com/PolarisMesh/website): 官网
- [samples](https://github.com/PolarisMesh/samples): 示例

## 快速入门

### 前置准备

#### 准备数据库

需要下载并安装MySQL，版本号要求>=5.7，可以在这里进行下载：https://dev.mysql.com/downloads/mysql/5.7.html

#### 导入数据库建表脚本

建表脚本为./store/defaultStore/polaris_server.sql，可通过mysql命令或者admin客户端进行导入

#### 准备golang编译环境

北极星服务端编译需要golang编译环境，版本号要求>=1.12，可以在这里进行下载：https://golang.org/dl/#featured

### 编译构建

````shell script
chmod +x build.sh
./build.sh
````
构建完后，可以在当前目录看到polaris-server-release_${version}.tar.gz的软件包。

### 安装

#### 解压软件包

获取polaris-server-release_${version}.tar.gz，并解压

#### 修改数据库配置

进入解压后的目录，打开polaris-server.yaml，替换DB配置相关的几个变量为实际的数据库参数；##DB_USER##（数据库用户名），##DB_PWD##（数据库密码），##DB_ADDR##（数据库地址），##DB_NAME##（数据库名称）

#### 执行安装脚本

````shell script
chmod +x ./tool/*.sh
#进行安装
./tool/install.sh
#测试进程是否启动成功
./tool/p.sh
````
最后一步运行p.sh后，返回Polaris Server，证明启动成功。

#### 验证安装

````shell script
curl http://127.0.0.1:8090
```` 
返回Polaris Server，证明功能正常


## 交流群

欢迎大家扫码加群交流，如果交流群已满 500 人，请加中间件小Q妹微信（微信号：midwareQmei），并发送入群暗号“polaris”，等待验证回复。

<img src="https://main.qcloudimg.com/raw/336e18b778f6c538d6f1e4ceeab31bf9.jpg" width="30%" height="30%" />

## 参与贡献

如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为提升北极星的开发体验贡献力量。

详见：[CONTRIBUTING.md](CONTRIBUTING.md)

[腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入。