You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/08/31 08:30:49 UTC
[incubator-servicecomb-docs] branch master updated: Introduction
dir translation (#48)
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 4e58310 Introduction dir translation (#48)
4e58310 is described below
commit 4e5831072cb680397ce69c2374281532ece089f0
Author: lidian <li...@huawei.com>
AuthorDate: Fri Aug 31 16:30:47 2018 +0800
Introduction dir translation (#48)
* update java-chassis-reference/en_US/start/architecture.md
* update java-chassis-reference/en_US/start/development-environment.md
* update java-chassis-reference/en_US/start/first-sample.md
* update java-chassis-reference/en_US/start/terminology.md
* update java-chassis-reference/en_US/introduction.md
* fix table issue java-chassis-reference/en_US/start/terminology.md
* update java-chassis-reference/en_US/start/architecture.md
* fix java-chassis-reference/en_US/start/architecture.md issue
* fix java-chassis-reference/en_US/start/development-environment.md issue
* fix java-chassis-reference/en_US/start/terminology.md issue
* Update architecture.md
* Update development-environment.md
* Update development-environment.md
---
java-chassis-reference/en_US/introduction.md | 12 ++-
java-chassis-reference/en_US/start/architecture.md | 40 ++++-----
.../en_US/start/development-environment.md | 98 +++++++++++-----------
java-chassis-reference/en_US/start/first-sample.md | 19 ++---
java-chassis-reference/en_US/start/terminology.md | 39 ++++-----
5 files changed, 101 insertions(+), 107 deletions(-)
diff --git a/java-chassis-reference/en_US/introduction.md b/java-chassis-reference/en_US/introduction.md
index c25475d..fc3718e 100644
--- a/java-chassis-reference/en_US/introduction.md
+++ b/java-chassis-reference/en_US/introduction.md
@@ -1,8 +1,6 @@
-# 概述
-Apache ServiceComb (incubating) Java Chassis 给开发者提供一个快速构建微服务的JAVA SDK。它包含如下特性：
+# Overview
+Apache ServiceComb (incubating) Java Chassis provides developers with a Java SDK to quickly build microservices. It contains the following features:
-* 多种开发风格，REST(JAX-RS、Spring MVC）和RPC
-* 多种通信协议, HTTP over Vert.x、Http Over Servlet、Highway等
-* 统一一致的服务提供者、服务消费者处理链，以及基于契约的开箱即用的服务治理能力
-
-开发者可以通过[Apache ServiceComb 的开放性设计](http://servicecomb.incubator.apache.org/cn/docs/open-design/)了解更多特性和设计原理。
+* Multiple development styles, REST (JAX-RS, Spring MVC) and RPC
+* Multiple communication protocols, HTTP over Vert.x, Http Over Servlet, Highway, etc.
+* Uniform service providers, service consumer handler, and contract-based out-of-the-box service governance capabilities
diff --git a/java-chassis-reference/en_US/start/architecture.md b/java-chassis-reference/en_US/start/architecture.md
index 33c5b3a..a8cf3e8 100644
--- a/java-chassis-reference/en_US/start/architecture.md
+++ b/java-chassis-reference/en_US/start/architecture.md
@@ -1,27 +1,27 @@
-# 微服务系统架构
+# Java Chassis Architecture
+## Basic Framework
+
-## 框架概述
+## Purpose
-## **主要设计意图**
+1.To decouple the programming model and communication model, so that a programming model can be combined with any communication models as needed. Application developers only need to focus on APIs during development and can flexibly switch communication models during deployment. Services can also be switched over to a legacy system. The developers simply need to modify the configuration file(or annotation) released by the service.
-1.编程模型和通信模型分离，不同的编程模型可以灵活组合不同的通信模型。应用开发者在开发阶段只关注接口开发，部署阶段灵活切换通信方式；支持legacy系统的切换，legacy系统只需要修改服务发布的配置文件（或者annotation），而不需要修改代码。
+Currently, applications can be developed in Spring MVC, JAX-RS, or transparent RPC mode.
-现阶段支持SpringMVC、JAX-RS和透明RPC三种开发方式。
+2. Built-in API-first support. Through contract standardize micro-service development, realizing cross-language communication, and supporting software toolchain (contract generation code, code generation contract, etc.) development, to construct a complete development ecology.
-2.内建API-first支持。通过契约规范化微服务开发，实现跨语言的通信，并支持配套的软件工具链（契约生成代码、代码生成契约等）开发，构建完整的开发生态。
+3.To define common microservice running model, encapsulating fault tolerance methods to process which from service discovery to interaction process of microservices, The running model can be customized or extended.
-3.定义了常用的微服务运行模型，将微服务从发现到交互过程中的各种容错手段都封装起来。该运行模型支持自定义和扩展。
+## Modules
-## **模块说明**
-
-| 类型 | artifact id | 是否可选 | 功能说明 |
-| :--- | :--- | :--- | :--- |
-| 编程模型 | provider-pojo | 是 | 提供RPC开发模式 |
-| 编程模型 | provider-jaxrs | 是 | 提供JAX RS开发模式 |
-| 编程模型 | provider-springmvc | 是 | 提供Spring MVC开发模式 |
-| 通信模型 | transport-rest-vertx | 是 | 运行于HTTP之上的开发框架，不依赖WEB容器，应用打包为可执行jar |
-| 通信模型 | transport-rest-servlet | 是 | 运行于WEB容器的开发框架，应用打包为war包 |
-| 通信模型 | transport-highway | 是 | 提供高性能的私有通信协议，仅用于java之间互通。 |
-| 运行模型 | handler-loadbalance | 是 | 负载均衡模块。提供各种路由策略和配置方法。一般客户端使用。 |
-| 运行模型 | handler-bizkeeper | 是 | 和服务治理相关的功能，比如隔离、熔断、容错。 |
-| 运行模型 | handler-tracing | 是 | 调用链跟踪模块，对接监控系统，吐出打点数据。 |
+| Type | artifact id | Available or NOT | Function |
+| :--------------------- | :--------------------- | :--------------- | :--------------------------------------- |
+| Programming model | provider-pojo | Yes | Provides the RPC development mode. |
+| Programming model | provider-jaxrs | Yes | Provides the JAX-RS development mode. |
+| Programming model | provider-springmvc | Yes | Provides the Spring MVC development mode. |
+| Communication on model | transport-rest-vertx | Yes | A development framework running over HTTP, it does not depend on Web containers. Applications are packaged as executable .jar files. |
+| Communication on model | transport-rest-servlet | Yes | A development framework running on Web container. Applications are packaged as WAR files. |
+| Communication on model | transport-highway | Yes | Provides high-performance private communication protocols for Java communication. |
+| Running model | handler-loadbalance | Yes | A load balancing module that provides various routing policies and configurations. It is usually used on the Consumer side. |
+| Running model | handler-bizkeeper | Yes | Provides service governance functions, such as isolation, fallbreak, and fault tolerance. |
+| Running model | handler-tracing | Yes | Invoke tracking chain module, Monitor system integration, Output data of buried point |
diff --git a/java-chassis-reference/en_US/start/development-environment.md b/java-chassis-reference/en_US/start/development-environment.md
index fa5a25e..524014d 100644
--- a/java-chassis-reference/en_US/start/development-environment.md
+++ b/java-chassis-reference/en_US/start/development-environment.md
@@ -1,24 +1,24 @@
-# 安装本地开发环境
+# Prepare the local development environment
-应用开发环境所需安装的工具包括JDK、Maven、Eclipse 和 IDEA 。如果已经安装了这些开发工具，请跳过本节。
+JDK, Maven, Eclipse, and IDEA is required. If you already have these development tools installed, skip this section.
-## JDK约束及安装步骤
+## JDK version and installation steps
-1.JDK版本
+1.JDK version
-JDK版本要求1.8以上。
+The JDK version requires 1.8 or higher.
-2.JDK下载
+2.JDK download
-请到JDK 1.8版本的官方地址下载。
+Please go to the official address of JDK version 1.8 to download.
-3.JDK安装
+3.JDK installation
-在官网下载JDK安装包后，选择合适的安装路径安装JDK。
+After downloading the JDK installation package on the official website, select the appropriate installation path to install the JDK.
-这里以windows系统为例：
+Here is the windows system as an example:
-设置JAVA\_HOME环境变量，指向Java安装目录。将%JAVA\_HOME%\bin添加到系统路径path中。环境变量配置完成后，使用java -version命令验证是否安装成功，windows环境下回显如下：
+Set the JAVA\_HOME environment variable to point to the Java installation directory. Add %JAVA\_HOME%\bin to the system path path. After the environment variable is configured, use the java -version command to verify whether the installation is successful. The windows environment is echoed as follows:
```
C:\Users\h00407576> java -version
@@ -27,33 +27,33 @@ C:\Users\h00407576> java -version
Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)
```
-## Maven安装步骤
+## Maven installation steps
-Maven是一款集项目管理、代码编译、工程管理等等能力于一体的开发工具。
+Maven is a development tool that integrates project management, code compilation and more.
-### **前提条件**
+### **Prerequisites**
-JDK已经安装成功。
+The JDK has been installed successfully.
-### **安装步骤**
+### **installation steps**
-a.在官方地址下载Maven安装包。
+a. Download the Maven installation package at the official address.
-b.（可选）在官方地址下载Eclipse插件m2eclipse。最新的Eclipse版本中带有Maven插件，则不用下载此插件
+b. (Optional) Download the Eclipse plugin m2eclipse at the official address. The latest Eclipse version comes with a Maven plugin, so you don't have to download this plugin.
-c.解压Maven安装包到本机路径。
+c. Unzip the Maven installation package to the native path.
-d.设置环境变量。
+d. Set environment variables.
-* 设置M2\_HOME环境变量，指向Maven安装目录。
+* Set the M2\_HOME environment variable to point to the Maven installation directory.
-* 将%M2\_HOME%\bin添加到系统路径path中。
+* Add %M2\_HOME%\bin to the system path path.
-e.（可选）设置本地仓库路径，用于保存从远程仓库获取的插件和依赖的副本。
+e. (Optional) Set a local repository path to hold the plug-ins and dependent copies obtained from the remote repository.
-这里以路径D:\maven\repository为例。在/conf中找到settings.xml文件，设置localRepository为D:\maven\repository
+Here is the path D:\maven\repository. Find the settings.xml file in /conf and set localRepository to D:\maven\repository
-f. （可选）要想项目能够快速的下载各种依赖，建议配置下中心仓库。
+f. (Optional) In order to quickly download various dependencies, it is recommended to configure the central repository.
```
<mirror>
@@ -64,9 +64,9 @@ f. （可选）要想项目能够快速的下载各种依赖，建议配置下
</mirror>
```
-g.结果验证
+g. Verification
-使用mvn -version命令验证是否安装成功，windows环境下回显如下：
+Use the mvn -version command to verify that the installation is successful. The windows environment is echoed as follows:
```
C:\Users\h00407576>mvn -version
@@ -79,46 +79,46 @@ C:\Users\h00407576>mvn -version
OS name: "windows 7", version: "6.1", arch: "amd64", family: "dos"
```
-## Eclipse安装
+## Eclipse installation
-### **前提条件**
+### **Prerequisites**
-a.JDK已经安装。
+a.JDK has been installed.
-b.Maven已经安装。
+b.Maven is already installed.
-### **安装步骤**
+### **installation steps**
-a.在官方地址下载Eclipse安装包。
+a. Download the Eclipse installation package at the official address.
-b.安装Eclipse到本机。
+b. Install Eclipse to the machine.
-c.（可选）将之前Maven安装中介绍的插件m2eclipse解压到Eclipse安装目录下的plugins和features目录。最新的Eclipse版本
+c. (Optional) Extract the plugin m2eclipse described in the previous Maven installation to the plugins and features directory in the Eclipse installation directory. The latest Eclipse version
-中带有Maven插件，不要进行此操作
+With the Maven plugin, don't do this
-d.启动Eclipse，配置jre、maven settings以及默认编码格式为utf-8。
+d. Start Eclipse, configure jre, maven settings, and the default encoding format is utf-8.
-## IDEA安装
+## IDEA installation
-### **前提条件**
+### **Prerequisites**
-a.JDK已经安装。
+a.JDK has been installed.
-b.Maven已经安装。
+b.Maven is already installed.
-### **安装步骤**
+### **installation steps**
-a. 在官方网站下载 IDEA 安装包，收费版或者社区版的按个人需求。
+a. Download the IDEA installation package on the official website, the paid version or the community version according to individual needs.
-b. 设置编码格式都为 utf-8。
+b. Set the encoding format to utf-8.
-打开IDEA，选择 File -> Settings -> Editor -> File Encoding
-把 project Encoding 和 default encoding for properties files 改为 utf-8。
+Open IDEA and select File -> Settings -> Editor -> File Encoding
+Change project Encoding and default encoding for properties files to utf-8.
-c. 设置maven 配置
+c. Set up maven configuration
-打开IDEA，选择 File -> Settings -> Build，Execution,Deployment -> Bulid Tools -> Maven
-注意配置 Maven home directory 和 User settings file
+Open IDEA and select File -> Settings -> Build, Execution, Deployment -> Bulid Tools -> Maven
+Note configuring Maven home directory and User settings file
diff --git a/java-chassis-reference/en_US/start/first-sample.md b/java-chassis-reference/en_US/start/first-sample.md
index 3ec45f4..275a7f8 100644
--- a/java-chassis-reference/en_US/start/first-sample.md
+++ b/java-chassis-reference/en_US/start/first-sample.md
@@ -1,18 +1,17 @@
-# 开发第一个微服务
+# Develop the first microservice
+Developers can quickly build a project in two ways:
-开发者可以通过两种方式快速构建一个项目：
+* Download the samples project. It is recommended to download the entire project, according to the example [SpringMVC] (https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/springmvc-sample) or [JAX RS] (https: //github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/jaxrs-sample) Initialize the configuration.
-* 下载samples项目。建议把整个项目都下载下来，按照例子[ SpringMVC ](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/springmvc-sample)或者 [JAX RS](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/jaxrs-sample)进行初始化配置。
+* Generate projects using archetypes
-* 使用archetypes生成项目
-
-开始之前，开发者需要先选择熟悉的开发方式，目前有3种方式可供选择：
+Before you start, developers need to choose a familiar development method. There are currently 3 ways to choose:
* Spring MVC
* JAX RS
* RPC
-他们对应的samples项目分别是：
-* [Spring MVC](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/springmvc-sample)
-* [JAX RS](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/jaxrs-sample)
+Their corresponding samples project are:
+* [Spring MVC] (https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/springmvc-sample)
+* [JAX RS] (https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/jaxrs-sample)
* [RPC](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/samples/pojo-sample)
-* 或者使用[archetypes](https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/archetypes)
+* Or use [archetypes] (https://github.com/apache/incubator-servicecomb-java-chassis/tree/master/archetypes)
\ No newline at end of file
diff --git a/java-chassis-reference/en_US/start/terminology.md b/java-chassis-reference/en_US/start/terminology.md
index 6ae16ed..8fe17b7 100644
--- a/java-chassis-reference/en_US/start/terminology.md
+++ b/java-chassis-reference/en_US/start/terminology.md
@@ -1,23 +1,20 @@
-## 表1-1术语表
+## Table 1-1 Glossary
-| 缩略语 | 英文词汇 | 中文词汇 | 解释 |
+| Abbreviations | English | Chinese | Acronyms |
| :--- | :--- | :--- | :--- |
-| MicroServices | MicroServices | 微服务 | 微服务是一种轻量级SOA架构，通常用来描述广泛用于云应用、互联网应用的一种松耦合分布式架构。 |
-| Provider | Provider | 服务提供者 | 在微服务调用关系中处于被调用一方的服务。 |
-| Consumer | Consumer | 服务消费者 | 在微服务调用关系中处于调用发起方的服务。 |
-| Application | Application | 应用 | 应用代表一个软件应用的逻辑实体，表示一个有业务功能呈现给用户的计算机软件应用。一个以微服务化架构构建的应用通常由多个微服务组成。 |
-| Instance | Instance | 微服务实例 | 一个微服务的最小运行和部署单元，通常对应一个应用进程。 |
-| IAM | Identity and Access Management | 身份及权限管理 | 负责PaaS系统中管理层级、用户、角色、授权关系，用户的组织归性等信息的维护。并实施授权和授权检查。 |
-| AK/SK | AK/SK | AK/SK密钥 | Access key/Secret key是一组密钥对，用于API的身份认证和访问控制。 |
-| Service | Service | 服务 | 服务是对按需取用的功能对象的一种描述。在应用模型中，服务一般面向应用，应用使用服务需要先订购服务，再绑定服务并使用，某些商业场景下可能还需要按使用量付费。 |
-| Load Balance | Load Balance | 负载均衡 | 当应用访问一个具有多个实例的微服务时，会涉及到路由负载均衡。可以通过配置文件配置负载均衡策略，支持随机，轮询、会话保持和基于响应时间的权值等多种负载均衡路由策略。 |
-| Rate limit | Rate limit | 限流 | 当资源成为瓶颈时，服务框架需要对消费者的访问请求做限流，启动流控保护机制。在服务消费者端和提供者端均可进行流量控制。在服务消费端，可以限制发往某个微服务提供者的请求频率；在服务提供端，可以限制每个微服务消费端发过来的请求频率，也可以根据服务提供端资源消耗情况确定总的请求频率限制，防止服务因资源耗尽而崩溃。 |
-| Service Degrade | Service Degrade | 降级 | 服务降级主要包括屏蔽降级和容错降级两种策略：屏蔽降级是指当外界的触发条件达到某个临界值时，由运维人员/开发人员决策，对某类或者某个服务进行强制降级。容错降级是指当非核心服务不可用时，可以对故障服务做业务逻辑放通，以保障核心服务的运行。 |
-| Fault tolarance | Fault tolarance | 容错 | 容错是消费者访问服务时出现异常的场景下的一种处理策略，出现异常后由服务框架自动选择新的服务路由进行调用。 |
-| Circuit Breaker | Circuit Breaker | 熔断 | 微服务之间通常存在依赖关系，服务调用链路可能包含多个微服务，如果链路中一个或多个服务访问延迟过高，会导致入口服务的请求不断堆积，持续消耗更多的线程、io资源，最终由于资源累积使系统出现瓶颈，造成更多服务不可用，产生雪崩效应。熔断机制就是针对上述场景设计的，当某个目标服务响应缓慢或者有大量超时情况发生时，熔断该服务的调用，对于后续调用请求，不再继续调用目标服务，直接返回，快速释放资源，等到该目标服务情况好转再恢复调用。 |
-| Isolation | Isolation | 隔离 | 服务隔离是一种异常检测机制，常用的检测方法是请求超时、流量过大等。一般的设置参数包括超时时间、最大并发请求数等，当超过超时时间或最大并发请求数时，记录一次异常，并用于在熔断机制中计算错误率和错误请求数。 |
-| Service Mesh | Service Mesh | 服务网格 | 一种基础设施层服务。在微服务化的过程中，开发者需要解决应用运行在分布式网络中所引入的问题，例如容错，限流，负载均衡，注册发现，可监控等，Service Mesh作为L4/L7协议代理，为应用解决了微服务化后带来的问题。 |
-| legacy | legacy | 遗留系统 | 遗留系统是一个还在运行和使用，但已步入软件生命周期衰老期的软件系统。 |
-
-
-
+| MicroServices | MicroServices | 微服务 | Microservices is a lightweight SOA architecture that is commonly used to describe a loosely coupled distributed architecture that is widely used in cloud applications and Internet applications. |
+| Provider | Provider | 服务提供者 | The service of the called party in the microservice invocation relationship. |
+| Consumer | Consumer | 服务消费者 | The service that invokes the initiator in the microservice invocation relationship. |
+| Application | Application | 应用 | A logical entity that represents a software application that represents a computer software application that has business functions presented to the user. An application built with a microservice architecture typically consists of multiple microservices. |
+| Instance | Instance | 微服务实例 | A minimal service and deployment unit for a microservice, usually corresponding to an application process. |
+| IAM | Identity and Access Management | 身份及权限管理 | Responsible for maintaining the management level, user, role, authorization relationship, user organization and other information in the PaaS system. And carry out authorization and authorization checks. |
+| AK/SK | AK/SK Key | AK/SK密钥 |Access key/Secret key is a set of key pairs used for API authentication and access control. |
+| Service | Service | 服务 | A service is a description of a functional object that is accessed on demand. In the application model, the service is generally oriented to the application. The application usage service needs to subscribe to the service first, then bind the service and use it. In some business scenarios, it may also need to pay according to usage. |
+| Load Balance | Load Balance | 负载均衡 | When an application accesses a microservice with multiple instances, it involves routing load balancing. Load balancing policies can be configured through configuration files to support multiple load balancing routing policies such as random, round-robin, session hold, and response time based weights. |
+| Rate limit | Rate limit | 限流 | When a resource becomes a bottleneck, the service framework needs to limit the access request of the consumer and start the flow control protection mechanism. Flow control is available on both the consumer and provider sides. On the service consumer side, the frequency of requests sent to a micro service provider can be limited; on the service provider side, the frequency of requests sent by each microservice consumer can be limited, or the total consumpt [...]
+| Service Degrade | Service Degrade | 降级 | Service downgrade mainly includes two strategies: masked downgrade and fault tolerant downgrade: shielded downgrade refers to the decision of the operation and maintenance personnel/developers when the trigger condition of the outside world reaches a certain critical value. Or a service is forced to downgrade. Fault-tolerant degradation means that when non-core services are unavailable, business logic can be released for faulty services to ensur [...]
+| Fault tolarance | Fault tolarance | 容错 | Fault Tolerance is a processing strategy in the scenario where an exception occurs when a consumer accesses a service. After an exception occurs, the service framework automatically selects a new service route to invoke. |
+| Circuit Breaker | Circuit Breaker | 熔断 | There is usually a dependency between microservices. The service invocation link may contain multiple microservices. If one or more service access delays in the link are too high, the request for the portal service will continue. Stacking, continue to consume more threads, io resources, and eventually the system bottleneck due to resource accumulation, resulting in more services unavailable, resulting in avalanche effect. The fuse mechanism is d [...]
+| Isolation | Isolation | 隔离 | Service isolation is an anomaly detection mechanism. Common detection methods are request timeout, excessive traffic, and so on. The general setting parameters include the timeout period, the maximum number of concurrent requests, etc. When the timeout period or the maximum number of concurrent requests is exceeded, an exception is recorded and used to calculate the error rate and the number of error requests in the fuse mechanism. |
+| Service Mesh | Service Mesh | 网格服务 | An infrastructure layer service. In the process of micro-service, developers need to solve the problems introduced by applications running in distributed networks, such as fault tolerance, current limiting, load balancing, registration discovery, monitoring, etc. Service Mesh acts as the L4/L7 protocol agent. The application solves the problems caused by micro-services. |
+| Legacy | Legacy | 遗留系统 | A legacy system is a software system that is still running and in use, but has entered the aging phase of the software lifecycle. |
\ No newline at end of file