repo_name
stringclasses 5
values | pr_number
int64 1.52k
15.5k
| pr_title
stringlengths 8
143
| pr_description
stringlengths 0
10.2k
| author
stringlengths 3
18
| date_created
unknown | date_merged
unknown | previous_commit
stringlengths 40
40
| pr_commit
stringlengths 40
40
| query
stringlengths 11
10.2k
| filepath
stringlengths 6
220
| before_content
stringlengths 0
597M
| after_content
stringlengths 0
597M
| label
int64 -1
1
|
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./CONTRIBUTING.md | ## Contributing to apollo
Apollo is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.
### Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
### Code Conventions
Our code style is in line with [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
We provide template files [intellij-java-google-style.xml](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) for IntelliJ IDEA and [eclipse-java-google-style.xml](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) for Eclipse. If you use other IDEs, then you may config manually by referencing the template files.
* Make sure all new .java files have a simple Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for.
* Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
* A few unit tests should be added for a new feature or an important bug fix.
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
* Normally, we would squash commits for one feature into one commit. There are 2 ways to do this:
1. To rebase and squash based on the remote branch
* `git rebase -i <remote>/master`
* merge commits via `fixup`, etc
2. Create a new branch and merge these commits into one
* `git checkout -b <some-branch-name> <remote>/master`
* `git merge --squash <current-feature-branch>`
* When writing a commit message please follow these conventions: if you are fixing an existing issue, please add Fixes #XXX at the end of the commit message (where XXX is the issue number).
| ## Contributing to apollo
Apollo is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.
### Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
### Code Conventions
Our code style is in line with [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
We provide template files [intellij-java-google-style.xml](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) for IntelliJ IDEA and [eclipse-java-google-style.xml](https://github.com/ctripcorp/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) for Eclipse. If you use other IDEs, then you may config manually by referencing the template files.
* Make sure all new .java files have a simple Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for.
* Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
* A few unit tests should be added for a new feature or an important bug fix.
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
* Normally, we would squash commits for one feature into one commit. There are 2 ways to do this:
1. To rebase and squash based on the remote branch
* `git rebase -i <remote>/master`
* merge commits via `fixup`, etc
2. Create a new branch and merge these commits into one
* `git checkout -b <some-branch-name> <remote>/master`
* `git merge --squash <current-feature-branch>`
* When writing a commit message please follow these conventions: if you are fixing an existing issue, please add Fixes #XXX at the end of the commit message (where XXX is the issue number).
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/usage/java-sdk-user-guide.md | >注意:本文档适用对象是Apollo系统的使用者,如果你是公司内Apollo系统的开发者/维护人员,建议先参考[Apollo开发指南](zh/development/apollo-development-guide)。
#
# 一、准备工作
## 1.1 环境要求
* Java: 1.7+
* Guava: 15.0+
* Apollo客户端默认会引用Guava 19,如果你的项目引用了其它版本,请确保版本号大于等于15.0
>注:对于Apollo客户端,如果有需要的话,可以做少量代码修改来降级到Java 1.6,详细信息可以参考[Issue 483](https://github.com/ctripcorp/apollo/issues/483)
## 1.2 必选设置
Apollo客户端依赖于`AppId`,`Apollo Meta Server`等环境信息来工作,所以请确保阅读下面的说明并且做正确的配置:
### 1.2.1 AppId
AppId是应用的身份信息,是从服务端获取配置的一个重要信息。
有以下几种方式设置,按照优先级从高到低分别为:
1. System Property
Apollo 0.7.0+支持通过System Property传入app.id信息,如
```bash
-Dapp.id=YOUR-APP-ID
```
2. 操作系统的System Environment
Apollo 1.4.0+支持通过操作系统的System Environment `APP_ID`来传入app.id信息,如
```bash
APP_ID=YOUR-APP-ID
```
3. Spring Boot application.properties
Apollo 1.0.0+支持通过Spring Boot的application.properties文件配置,如
```properties
app.id=YOUR-APP-ID
```
> 该配置方式不适用于多个war包部署在同一个tomcat的使用场景
4. app.properties
确保classpath:/META-INF/app.properties文件存在,并且其中内容形如:
>app.id=YOUR-APP-ID
文件位置参考如下:
![app-id-location](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/app-id-location.png)
> 注:app.id是用来标识应用身份的唯一id,格式为string。
### 1.2.2 Apollo Meta Server
Apollo支持应用在不同的环境有不同的配置,所以需要在运行提供给Apollo客户端当前环境的[Apollo Meta Server](zh/design/apollo-design?id=_133-meta-server)信息。默认情况下,meta server和config service是部署在同一个JVM进程,所以meta server的地址就是config service的地址。
为了实现meta server的高可用,推荐通过SLB(Software Load Balancer)做动态负载均衡。Meta server地址也可以填入IP,如`http://1.1.1.1:8080,http://2.2.2.2:8080`,不过生产环境还是建议使用域名(走slb),因为机器扩容、缩容等都可能导致IP列表的变化。
1.0.0版本开始支持以下方式配置apollo meta server信息,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.meta`
* 可以通过Java的System Property `apollo.meta`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.meta=http://config-service-url`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.meta=http://config-service-url -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.meta", "http://config-service-url");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.meta=http://config-service-url`
> 该配置方式不适用于多个war包部署在同一个tomcat的使用场景
3. 通过操作系统的System Environment`APOLLO_META`
* 可以通过操作系统的System Environment `APOLLO_META`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.meta=http://config-service-url`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
5. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.meta=http://config-service-url`
6. 通过Java system property `${env}_meta`
* 如果当前[env](#_1241-environment)是`dev`,那么用户可以配置`-Ddev_meta=http://config-service-url`
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
7. 通过操作系统的System Environment `${ENV}_META` (1.2.0版本开始支持)
* 如果当前[env](#_1241-environment)是`dev`,那么用户可以配置操作系统的System Environment `DEV_META=http://config-service-url`
* 注意key为全大写
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
8. 通过`apollo-env.properties`文件
* 用户也可以创建一个`apollo-env.properties`,放在程序的classpath下,或者放在spring boot应用的config目录下
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
* 文件内容形如:
```properties
dev.meta=http://1.1.1.1:8080
fat.meta=http://apollo.fat.xxx.com
uat.meta=http://apollo.uat.xxx.com
pro.meta=http://apollo.xxx.com
```
> 如果通过以上各种手段都无法获取到Meta Server地址,Apollo最终会fallback到`http://apollo.meta`作为Meta Server地址
#### 1.2.2.1 自定义Apollo Meta Server地址定位逻辑
在1.0.0版本中,Apollo提供了[MetaServerProvider SPI](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/spi/MetaServerProvider.java),用户可以注入自己的MetaServerProvider来自定义Meta Server地址定位逻辑。
由于我们使用典型的[Java Service Loader模式](https://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html),所以实现起来还是比较简单的。
有一点需要注意的是,apollo会在运行时按照顺序遍历所有的MetaServerProvider,直到某一个MetaServerProvider提供了一个非空的Meta Server地址,因此用户需要格外注意自定义MetaServerProvider的Order。规则是较小的Order具有较高的优先级,因此Order=0的MetaServerProvider会排在Order=1的MetaServerProvider的前面。
**如果你的公司有很多应用需要接入Apollo,建议封装一个jar包,然后提供自定义的Apollo Meta Server定位逻辑,从而可以让接入Apollo的应用零配置使用。比如自己写一个`xx-company-apollo-client`,该jar包依赖`apollo-client`,在该jar包中通过spi方式定义自定义的MetaServerProvider实现,然后应用直接依赖`xx-company-apollo-client`即可。**
MetaServerProvider的实现可以参考[LegacyMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/internals/LegacyMetaServerProvider.java)和[DefaultMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultMetaServerProvider.java)。
#### 1.2.2.2 跳过Apollo Meta Server服务发现
> 适用于apollo-client 0.11.0及以上版本
一般情况下都建议使用Apollo的Meta Server机制来实现Config Service的服务发现,从而可以实现Config Service的高可用。不过apollo-client也支持跳过Meta Server服务发现,主要用于以下场景:
1. Config Service部署在公有云上,注册到Meta Server的是内网地址,本地开发环境无法直接连接
* 如果通过公网 SLB 对外暴露 Config Service的话,记得要设置 IP 白名单,避免数据泄露
2. Config Service部署在docker环境中,注册到Meta Server的是docker内网地址,本地开发环境无法直接连接
3. Config Service部署在kubernetes中,希望使用kubernetes自带的服务发现能力(Service)
针对以上场景,可以通过直接指定Config Service地址的方式来跳过Meta Server服务发现,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.configService`
* 可以通过Java的System Property `apollo.configService`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.configService=http://config-service-url:port`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.configService=http://config-service-url:port -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.configService", "http://config-service-url:port");`
2. 通过操作系统的System Environment`APOLLO_CONFIGSERVICE`
* 可以通过操作系统的System Environment `APOLLO_CONFIGSERVICE`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.configService=http://config-service-url:port`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
### 1.2.3 本地缓存路径
Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份,用于在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置,不影响应用正常运行。
本地缓存路径默认位于以下路径,所以请确保`/opt/data`或`C:\opt\data\`目录存在,且应用有读写权限。
* **Mac/Linux**: /opt/data/{_appId_}/config-cache
* **Windows**: C:\opt\data\\{_appId_}\config-cache
本地配置文件会以下面的文件名格式放置于本地缓存路径下:
**_{appId}+{cluster}+{namespace}.properties_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用的配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/client-local-cache.png)
文件内容以properties格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```properties
request.timeout=2000
batch=2000
```
#### 1.2.3.1 自定义缓存路径
1.0.0版本开始支持以下方式自定义缓存路径,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.cacheDir`
* 可以通过Java的System Property `apollo.cacheDir`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.cacheDir=/opt/data/some-cache-dir`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.cacheDir=/opt/data/some-cache-dir -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.cacheDir", "/opt/data/some-cache-dir");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.cacheDir=/opt/data/some-cache-dir`
3. 通过操作系统的System Environment`APOLLO_CACHEDIR`
* 可以通过操作系统的System Environment `APOLLO_CACHEDIR`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.cacheDir=/opt/data/some-cache-dir`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
> 注:本地缓存路径也可用于容灾目录,如果应用在所有config service都挂掉的情况下需要扩容,那么也可以先把配置从已有机器上的缓存路径复制到新机器上的相同缓存路径
### 1.2.4 可选设置
#### 1.2.4.1 Environment
Environment可以通过以下3种方式的任意一个配置:
1. 通过Java System Property
* 可以通过Java的System Property `env`来指定环境
* 在Java程序启动脚本中,可以指定`-Denv=YOUR-ENVIRONMENT`
* 如果是运行jar文件,需要注意格式是`java -Denv=YOUR-ENVIRONMENT -jar xxx.jar`
* 注意key为全小写
2. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `ENV`来指定
* 注意key为全大写
3. 通过配置文件
* 最后一个推荐的方式是通过配置文件来指定`env=YOUR-ENVIRONMENT`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
文件内容形如:
```properties
env=DEV
```
目前,`env`支持以下几个值(大小写不敏感):
* DEV
* Development environment
* FAT
* Feature Acceptance Test environment
* UAT
* User Acceptance Test environment
* PRO
* Production environment
更多环境定义,可以参考[Env.java](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/Env.java)
#### 1.2.4.2 Cluster(集群)
Apollo支持配置按照集群划分,也就是说对于一个appId和一个环境,对不同的集群可以有不同的配置。
1.0.0版本开始支持以下方式集群,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.cluster`
* 可以通过Java的System Property `apollo.cluster`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.cluster=SomeCluster`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.cluster=SomeCluster -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.cluster", "SomeCluster");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.cluster=SomeCluster`
3. 通过Java System Property
* 可以通过Java的System Property `idc`来指定环境
* 在Java程序启动脚本中,可以指定`-Didc=xxx`
* 如果是运行jar文件,需要注意格式是`java -Didc=xxx -jar xxx.jar`
* 注意key为全小写
4. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `IDC`来指定
* 注意key为全大写
5. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`idc=xxx`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
**Cluster Precedence**(集群顺序)
1. 如果`apollo.cluster`和`idc`同时指定:
* 我们会首先尝试从`apollo.cluster`指定的集群加载配置
* 如果没找到任何配置,会尝试从`idc`指定的集群加载配置
* 如果还是没找到,会从默认的集群(`default`)加载
2. 如果只指定了`apollo.cluster`:
* 我们会首先尝试从`apollo.cluster`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
3. 如果只指定了`idc`:
* 我们会首先尝试从`idc`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
4. 如果`apollo.cluster`和`idc`都没有指定:
* 我们会从默认的集群(`default`)加载配置
#### 1.2.4.3 设置内存中的配置项是否保持和页面上的顺序一致
> 适用于1.6.0及以上版本
默认情况下,apollo client内存中的配置存放在Properties中(底下是Hashtable),不会刻意保持和页面上看到的顺序一致,对绝大部分的场景是没有影响的。不过有些场景会强依赖配置项的顺序(如spring cloud zuul的路由规则),针对这种情况,可以开启OrderedProperties特性来使得内存中的配置顺序和页面上看到的一致。
配置方式按照优先级从高到低分别为:
1. 通过Java System Property `apollo.property.order.enable`
* 可以通过Java的System Property `apollo.property.order.enable`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.property.order.enable=true`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.property.order.enable=true -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.property.order.enable", "true");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.property.order.enable=true`
3. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.property.order.enable=true`
#### 1.2.4.4 配置访问密钥
> 适用于1.6.0及以上版本
Apollo从1.6.0版本开始增加访问密钥机制,从而只有经过身份验证的客户端才能访问敏感配置。如果应用开启了访问密钥,客户端需要配置密钥,否则无法获取配置。
配置方式按照优先级从高到低分别为:
1. 通过Java System Property `apollo.accesskey.secret`
* 可以通过Java的System Property `apollo.accesskey.secret`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719 -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.accesskey.secret", "1cf998c4e2ad4704b45a98a509d15719");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
3. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `APOLLO_ACCESSKEY_SECRET`来指定
* 注意key为全大写
4. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
# 二、Maven Dependency
Apollo的客户端jar包已经上传到中央仓库,应用在实际使用时只需要按照如下方式引入即可。
```xml
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>1.7.0</version>
</dependency>
```
# 三、客户端用法
Apollo支持API方式和Spring整合方式,该怎么选择用哪一种方式?
* API方式灵活,功能完备,配置值实时更新(热发布),支持所有Java环境。
* Spring方式接入简单,结合Spring有N种酷炫的玩法,如
* Placeholder方式:
* 代码中直接使用,如:`@Value("${someKeyFromApollo:someDefaultValue}")`
* 配置文件中使用替换placeholder,如:`spring.datasource.url: ${someKeyFromApollo:someDefaultValue}`
* 直接托管spring的配置,如在apollo中直接配置`spring.datasource.url=jdbc:mysql://localhost:3306/somedb?characterEncoding=utf8`
* Spring boot的[@ConfigurationProperties](http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/properties/ConfigurationProperties.html)方式
* 从v0.10.0开始的版本支持placeholder在运行时自动更新,具体参见[PR #972](https://github.com/ctripcorp/apollo/pull/972)。(v0.10.0之前的版本在配置变化后不会重新注入,需要重启才会更新,如果需要配置值实时更新,可以参考后续[3.2.2 Spring Placeholder的使用](#_322-spring-placeholder的使用)的说明)
* Spring方式也可以结合API方式使用,如注入Apollo的Config对象,就可以照常通过API方式获取配置了:
```java
@ApolloConfig
private Config config; //inject config for namespace application
```
* 更多有意思的实际使用场景和示例代码,请参考[apollo-use-cases](https://github.com/ctripcorp/apollo-use-cases)
## 3.1 API使用方式
API方式是最简单、高效使用Apollo配置的方式,不依赖Spring框架即可使用。
### 3.1.1 获取默认namespace的配置(application)
```java
Config config = ConfigService.getAppConfig(); //config instance is singleton for each namespace and is never null
String someKey = "someKeyFromDefaultNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
通过上述的**config.getProperty**可以获取到someKey对应的实时最新的配置值。
另外,配置值从内存中获取,所以不需要应用自己做缓存。
### 3.1.2 监听配置变化事件
监听配置变化事件只在应用真的关心配置变化,需要在配置变化时得到通知时使用,比如:数据库连接串变化后需要重建连接等。
如果只是希望每次都取到最新的配置的话,只需要按照上面的例子,调用**config.getProperty**即可。
```java
Config config = ConfigService.getAppConfig(); //config instance is singleton for each namespace and is never null
config.addChangeListener(new ConfigChangeListener() {
@Override
public void onChange(ConfigChangeEvent changeEvent) {
System.out.println("Changes for namespace " + changeEvent.getNamespace());
for (String key : changeEvent.changedKeys()) {
ConfigChange change = changeEvent.getChange(key);
System.out.println(String.format("Found change - key: %s, oldValue: %s, newValue: %s, changeType: %s", change.getPropertyName(), change.getOldValue(), change.getNewValue(), change.getChangeType()));
}
}
});
```
### 3.1.3 获取公共Namespace的配置
```java
String somePublicNamespace = "CAT";
Config config = ConfigService.getConfig(somePublicNamespace); //config instance is singleton for each namespace and is never null
String someKey = "someKeyFromPublicNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
### 3.1.4 获取非properties格式namespace的配置
#### 3.1.4.1 yaml/yml格式的namespace
apollo-client 1.3.0版本开始对yaml/yml做了更好的支持,使用起来和properties格式一致。
```java
Config config = ConfigService.getConfig("application.yml");
String someKey = "someKeyFromYmlNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
#### 3.1.4.2 非yaml/yml格式的namespace
获取时需要使用`ConfigService.getConfigFile`接口并指定Format,如`ConfigFileFormat.XML`。
```java
String someNamespace = "test";
ConfigFile configFile = ConfigService.getConfigFile("test", ConfigFileFormat.XML);
String content = configFile.getContent();
```
## 3.2 Spring整合方式
### 3.2.1 配置
Apollo也支持和Spring整合(Spring 3.1.1+),只需要做一些简单的配置就可以了。
Apollo目前既支持比较传统的`基于XML`的配置,也支持目前比较流行的`基于Java(推荐)`的配置。
如果是Spring Boot环境,建议参照[3.2.1.3 Spring Boot集成方式(推荐)](#_3213-spring-boot集成方式(推荐))配置。
需要注意的是,如果之前有使用`org.springframework.beans.factory.config.PropertyPlaceholderConfigurer`的,请替换成`org.springframework.context.support.PropertySourcesPlaceholderConfigurer`。Spring 3.1以后就不建议使用PropertyPlaceholderConfigurer了,要改用PropertySourcesPlaceholderConfigurer。
如果之前有使用`<context:property-placeholder>`,请注意xml中引入的`spring-context.xsd`版本需要是3.1以上(一般只要没有指定版本会自动升级的),建议使用不带版本号的形式引入,如:`http://www.springframework.org/schema/context/spring-context.xsd`
> 注1:yaml/yml格式的namespace从1.3.0版本开始支持和Spring整合,注入时需要填写带后缀的完整名字,比如application.yml
> 注2:非properties、非yaml/yml格式(如xml,json等)的namespace暂不支持和Spring整合。
#### 3.2.1.1 基于XML的配置
>注:需要把apollo相关的xml namespace加到配置文件头上,不然会报xml语法错误。
1.注入默认namespace的配置到Spring中
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<!-- 这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中 -->
<apollo:config/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
2.注入多个namespace的配置到Spring中
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<!-- 这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中 -->
<apollo:config/>
<!-- 这个是稍微复杂一些的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中 -->
<apollo:config namespaces="FX.apollo,application.yml"/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
3.注入多个namespace,并且指定顺序
Spring的配置是有顺序的,如果多个property source都有同一个key,那么最终是顺序在前的配置生效。
<apollo:config>如果不指定order,那么默认是最低优先级。
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<apollo:config order="2"/>
<!-- 这个是最复杂的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中,并且顺序在application前面 -->
<apollo:config namespaces="FX.apollo,application.yml" order="1"/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
#### 3.2.1.2 基于Java的配置(推荐)
相对于基于XML的配置,基于Java的配置是目前比较流行的方式。
注意`@EnableApolloConfig`要和`@Configuration`一起使用,不然不会生效。
1.注入默认namespace的配置到Spring中
```java
//这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
```
2.注入多个namespace的配置到Spring中
```java
@Configuration
@EnableApolloConfig
public class SomeAppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
//这个是稍微复杂一些的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中
@Configuration
@EnableApolloConfig({"FX.apollo", "application.yml"})
public class AnotherAppConfig {}
```
3.注入多个namespace,并且指定顺序
```java
//这个是最复杂的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中,并且顺序在application前面
@Configuration
@EnableApolloConfig(order = 2)
public class SomeAppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
@Configuration
@EnableApolloConfig(value = {"FX.apollo", "application.yml"}, order = 1)
public class AnotherAppConfig {}
```
#### 3.2.1.3 Spring Boot集成方式(推荐)
Spring Boot除了支持上述两种集成方式以外,还支持通过application.properties/bootstrap.properties来配置,该方式能使配置在更早的阶段注入,比如使用`@ConditionalOnProperty`的场景或者是有一些spring-boot-starter在启动阶段就需要读取配置做一些事情(如[dubbo-spring-boot-project](https://github.com/apache/incubator-dubbo-spring-boot-project)),所以对于Spring Boot环境建议通过以下方式来接入Apollo(需要0.10.0及以上版本)。
使用方式很简单,只需要在application.properties/bootstrap.properties中按照如下样例配置即可。
1. 注入默认`application` namespace的配置示例
```properties
# will inject 'application' namespace in bootstrap phase
apollo.bootstrap.enabled = true
```
2. 注入非默认`application` namespace或多个namespace的配置示例
```properties
apollo.bootstrap.enabled = true
# will inject 'application', 'FX.apollo' and 'application.yml' namespaces in bootstrap phase
apollo.bootstrap.namespaces = application,FX.apollo,application.yml
```
3. 将Apollo配置加载提到初始化日志系统之前(1.2.0+)
从1.2.0版本开始,如果希望把日志相关的配置(如`logging.level.root=info`或`logback-spring.xml`中的参数)也放在Apollo管理,那么可以额外配置`apollo.bootstrap.eagerLoad.enabled=true`来使Apollo的加载顺序放到日志系统加载之前,不过这会导致Apollo的启动过程无法通过日志的方式输出(因为执行Apollo加载的时候,日志系统压根没有准备好呢!所以在Apollo代码中使用Slf4j的日志输出便没有任何内容),更多信息可以参考[PR 1614](https://github.com/ctripcorp/apollo/pull/1614)。参考配置示例如下:
```properties
# will inject 'application' namespace in bootstrap phase
apollo.bootstrap.enabled = true
# put apollo initialization before logging system initialization
apollo.bootstrap.eagerLoad.enabled=true
```
### 3.2.2 Spring Placeholder的使用
Spring应用通常会使用Placeholder来注入配置,使用的格式形如${someKey:someDefaultValue},如${timeout:100}。冒号前面的是key,冒号后面的是默认值。
建议在实际使用时尽量给出默认值,以免由于key没有定义导致运行时错误。
从v0.10.0开始的版本支持placeholder在运行时自动更新,具体参见[PR #972](https://github.com/ctripcorp/apollo/pull/972)。
如果需要关闭placeholder在运行时自动更新功能,可以通过以下两种方式关闭:
1. 通过设置System Property `apollo.autoUpdateInjectedSpringProperties`,如启动时传入`-Dapollo.autoUpdateInjectedSpringProperties=false`
2. 通过设置META-INF/app.properties中的`apollo.autoUpdateInjectedSpringProperties`属性,如
```properties
app.id=SampleApp
apollo.autoUpdateInjectedSpringProperties=false
```
#### 3.2.2.1 XML使用方式
假设我有一个TestXmlBean,它有两个配置项需要注入:
```java
public class TestXmlBean {
private int timeout;
private int batch;
public void setTimeout(int timeout) {
this.timeout = timeout;
}
public void setBatch(int batch) {
this.batch = batch;
}
public int getTimeout() {
return timeout;
}
public int getBatch() {
return batch;
}
}
```
那么,我在XML中会使用如下方式来定义(假设应用默认的application namespace中有timeout和batch的配置项):
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<apollo:config/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
#### 3.2.2.2 Java Config使用方式
假设我有一个TestJavaConfigBean,通过Java Config的方式还可以使用@Value的方式注入:
```java
public class TestJavaConfigBean {
@Value("${timeout:100}")
private int timeout;
private int batch;
@Value("${batch:200}")
public void setBatch(int batch) {
this.batch = batch;
}
public int getTimeout() {
return timeout;
}
public int getBatch() {
return batch;
}
}
```
在Configuration类中按照下面的方式使用(假设应用默认的application namespace中有`timeout`和`batch`的配置项):
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
```
#### 3.2.2.3 ConfigurationProperties使用方式
Spring Boot提供了[@ConfigurationProperties](http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/properties/ConfigurationProperties.html)把配置注入到bean对象中。
Apollo也支持这种方式,下面的例子会把`redis.cache.expireSeconds`和`redis.cache.commandTimeout`分别注入到SampleRedisConfig的`expireSeconds`和`commandTimeout`字段中。
```java
@ConfigurationProperties(prefix = "redis.cache")
public class SampleRedisConfig {
private int expireSeconds;
private int commandTimeout;
public void setExpireSeconds(int expireSeconds) {
this.expireSeconds = expireSeconds;
}
public void setCommandTimeout(int commandTimeout) {
this.commandTimeout = commandTimeout;
}
}
```
在Configuration类中按照下面的方式使用(假设应用默认的application namespace中有`redis.cache.expireSeconds`和`redis.cache.commandTimeout`的配置项):
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public SampleRedisConfig sampleRedisConfig() {
return new SampleRedisConfig();
}
}
```
需要注意的是,`@ConfigurationProperties`如果需要在Apollo配置变化时自动更新注入的值,需要配合使用[EnvironmentChangeEvent](https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_environment_changes)或[RefreshScope](https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_refresh_scope)。相关代码实现,可以参考apollo-use-cases项目中的[ZuulPropertiesRefresher.java](https://github.com/ctripcorp/apollo-use-cases/blob/master/spring-cloud-zuul/src/main/java/com/ctrip/framework/apollo/use/cases/spring/cloud/zuul/ZuulPropertiesRefresher.java#L48)和apollo-demo项目中的[SampleRedisConfig.java](https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/config/SampleRedisConfig.java)以及[SpringBootApolloRefreshConfig.java](https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/refresh/SpringBootApolloRefreshConfig.java)
### 3.2.3 Spring Annotation支持
Apollo同时还增加了几个新的Annotation来简化在Spring环境中的使用。
1. @ApolloConfig
* 用来自动注入Config对象
2. @ApolloConfigChangeListener
* 用来自动注册ConfigChangeListener
3. @ApolloJsonValue
* 用来把配置的json字符串自动注入为对象
使用样例如下:
```java
public class TestApolloAnnotationBean {
@ApolloConfig
private Config config; //inject config for namespace application
@ApolloConfig("application")
private Config anotherConfig; //inject config for namespace application
@ApolloConfig("FX.apollo")
private Config yetAnotherConfig; //inject config for namespace FX.apollo
@ApolloConfig("application.yml")
private Config ymlConfig; //inject config for namespace application.yml
/**
* ApolloJsonValue annotated on fields example, the default value is specified as empty list - []
* <br />
* jsonBeanProperty=[{"someString":"hello","someInt":100},{"someString":"world!","someInt":200}]
*/
@ApolloJsonValue("${jsonBeanProperty:[]}")
private List<JsonBean> anotherJsonBeans;
@Value("${batch:100}")
private int batch;
//config change listener for namespace application
@ApolloConfigChangeListener
private void someOnChange(ConfigChangeEvent changeEvent) {
//update injected value of batch if it is changed in Apollo
if (changeEvent.isChanged("batch")) {
batch = config.getIntProperty("batch", 100);
}
}
//config change listener for namespace application
@ApolloConfigChangeListener("application")
private void anotherOnChange(ConfigChangeEvent changeEvent) {
//do something
}
//config change listener for namespaces application, FX.apollo and application.yml
@ApolloConfigChangeListener({"application", "FX.apollo", "application.yml"})
private void yetAnotherOnChange(ConfigChangeEvent changeEvent) {
//do something
}
//example of getting config from Apollo directly
//this will always return the latest value of timeout
public int getTimeout() {
return config.getIntProperty("timeout", 200);
}
//example of getting config from injected value
//the program needs to update the injected value when batch is changed in Apollo using @ApolloConfigChangeListener shown above
public int getBatch() {
return this.batch;
}
private static class JsonBean{
private String someString;
private int someInt;
}
}
```
在Configuration类中按照下面的方式使用:
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestApolloAnnotationBean testApolloAnnotationBean() {
return new TestApolloAnnotationBean();
}
}
```
### 3.2.4 已有配置迁移
很多情况下,应用可能已经有不少配置了,比如Spring Boot的应用,就会有bootstrap.properties/yml, application.properties/yml等配置。
在应用接入Apollo之后,这些配置是可以非常方便的迁移到Apollo的,具体步骤如下:
1. 在Apollo为应用新建项目
2. 在应用中配置好META-INF/app.properties
3. 建议把原先配置先转为properties格式,然后通过Apollo提供的文本编辑模式全部粘帖到应用的application namespace,发布配置
* 如果原来格式是yml,可以使用[YamlPropertiesFactoryBean.getObject](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.html#getObject--)转成properties格式
4. 如果原来是yml,想继续使用yml来编辑配置,那么可以创建私有的application.yml namespace,把原来的配置全部粘贴进去,发布配置
* 需要apollo-client是1.3.0及以上版本
5. 把原先的配置文件如bootstrap.properties/yml, application.properties/yml从项目中删除
* 如果需要保留本地配置文件,需要注意部分配置如`server.port`必须确保本地文件已经删除该配置项
如:
```properties
spring.application.name = reservation-service
server.port = 8080
logging.level = ERROR
eureka.client.serviceUrl.defaultZone = http://127.0.0.1:8761/eureka/
eureka.client.healthcheck.enabled = true
eureka.client.registerWithEureka = true
eureka.client.fetchRegistry = true
eureka.client.eurekaServiceUrlPollIntervalSeconds = 60
eureka.instance.preferIpAddress = true
```
![text-mode-spring-boot-config-sample](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-spring-boot-config-sample.png)
## 3.3 Demo
项目中有一个样例客户端的项目:`apollo-demo`,具体信息可以参考[Apollo开发指南](zh/development/apollo-development-guide)中的[2.3 Java样例客户端启动](zh/development/apollo-development-guide?id=_23-java样例客户端启动)部分。
更多使用案例Demo可以参考[Apollo使用场景和示例代码](https://github.com/ctripcorp/apollo-use-cases)。
# 四、客户端设计
![client-architecture](https://github.com/ctripcorp/apollo/raw/master/doc/images/client-architecture.png)
上图简要描述了Apollo客户端的实现原理:
1. 客户端和服务端保持了一个长连接,从而能第一时间获得配置更新的推送。(通过Http Long Polling实现)
2. 客户端还会定时从Apollo配置中心服务端拉取应用的最新配置。
* 这是一个fallback机制,为了防止推送机制失效导致配置不更新
* 客户端定时拉取会上报本地版本,所以一般情况下,对于定时拉取的操作,服务端都会返回304 - Not Modified
* 定时频率默认为每5分钟拉取一次,客户端也可以通过在运行时指定System Property: `apollo.refreshInterval`来覆盖,单位为分钟。
3. 客户端从Apollo配置中心服务端获取到应用的最新配置后,会保存在内存中
4. 客户端会把从服务端获取到的配置在本地文件系统缓存一份
* 在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置
5. 应用程序可以从Apollo客户端获取最新的配置、订阅配置更新通知
# 五、本地开发模式
Apollo客户端还支持本地开发模式,这个主要用于当开发环境无法连接Apollo服务器的时候,比如在邮轮、飞机上做相关功能开发。
在本地开发模式下,Apollo只会从本地文件读取配置信息,不会从Apollo服务器读取配置。
可以通过下面的步骤开启Apollo本地开发模式。
## 5.1 修改环境
修改/opt/settings/server.properties(Mac/Linux)或C:\opt\settings\server.properties(Windows)文件,设置env为Local:
```properties
env=Local
```
更多配置环境的方式请参考[1.2.4.1 Environment](#_1241-environment)
## 5.2 准备本地配置文件
在本地开发模式下,Apollo客户端会从本地读取文件,所以我们需要事先准备好配置文件。
### 5.2.1 本地配置目录
本地配置目录位于:
* **Mac/Linux**: /opt/data/{_appId_}/config-cache
* **Windows**: C:\opt\data\\{_appId_}\config-cache
appId就是应用的appId,如100004458。
请确保该目录存在,且应用程序对该目录有读权限。
**【小技巧】** 推荐的方式是先在普通模式下使用Apollo,这样Apollo会自动创建该目录并在目录下生成配置文件。
### 5.2.2 本地配置文件
本地配置文件需要按照一定的文件名格式放置于本地配置目录下,文件名格式如下:
**_{appId}+{cluster}+{namespace}.properties_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用的配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/client-local-cache.png)
文件内容以properties格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```properties
request.timeout=2000
batch=2000
```
## 5.3 修改配置
在本地开发模式下,Apollo不会实时监测文件内容是否有变化,所以如果修改了配置,需要重启应用生效。
# 六、测试模式
1.1.0版本开始增加了`apollo-mockserver`,从而可以很好地支持单元测试时需要mock配置的场景,使用方法如下:
## 6.1 引入pom依赖
```xml
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-mockserver</artifactId>
<version>1.7.0</version>
</dependency>
```
## 6.2 在test的resources下放置mock的数据
文件名格式约定为`mockdata-{namespace}.properties`
![image](https://user-images.githubusercontent.com/17842829/44515526-5e0e6480-a6f5-11e8-9c3c-4ff2ec737c8d.png)
## 6.3 写测试类
更多使用demo可以参考[ApolloMockServerApiTest.java](https://github.com/ctripcorp/apollo/blob/master/apollo-mockserver/src/test/java/com/ctrip/framework/apollo/mockserver/ApolloMockServerApiTest.java)和[ApolloMockServerSpringIntegrationTest.java](https://github.com/ctripcorp/apollo/blob/master/apollo-mockserver/src/test/java/com/ctrip/framework/apollo/mockserver/ApolloMockServerSpringIntegrationTest.java)。
```java
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfiguration.class)
public class SpringIntegrationTest {
// 启动apollo的mockserver
@ClassRule
public static EmbeddedApollo embeddedApollo = new EmbeddedApollo();
@Test
@DirtiesContext // 这个注解很有必要,因为配置注入会弄脏应用上下文
public void testPropertyInject(){
assertEquals("value1", testBean.key1);
assertEquals("value2", testBean.key2);
}
@Test
@DirtiesContext
public void testListenerTriggeredByAdd() throws InterruptedException, ExecutionException, TimeoutException {
String otherNamespace = "othernamespace";
embeddedApollo.addOrModifyPropery(otherNamespace,"someKey","someValue");
ConfigChangeEvent changeEvent = testBean.futureData.get(5000, TimeUnit.MILLISECONDS);
assertEquals(otherNamespace, changeEvent.getNamespace());
assertEquals("someValue", changeEvent.getChange("someKey").getNewValue());
}
@EnableApolloConfig("application")
@Configuration
static class TestConfiguration{
@Bean
public TestBean testBean(){
return new TestBean();
}
}
static class TestBean{
@Value("${key1:default}")
String key1;
@Value("${key2:default}")
String key2;
SettableFuture<ConfigChangeEvent> futureData = SettableFuture.create();
@ApolloConfigChangeListener("othernamespace")
private void onChange(ConfigChangeEvent changeEvent) {
futureData.set(changeEvent);
}
}
}
```
| >注意:本文档适用对象是Apollo系统的使用者,如果你是公司内Apollo系统的开发者/维护人员,建议先参考[Apollo开发指南](zh/development/apollo-development-guide)。
#
# 一、准备工作
## 1.1 环境要求
* Java: 1.7+
* Guava: 15.0+
* Apollo客户端默认会引用Guava 19,如果你的项目引用了其它版本,请确保版本号大于等于15.0
>注:对于Apollo客户端,如果有需要的话,可以做少量代码修改来降级到Java 1.6,详细信息可以参考[Issue 483](https://github.com/ctripcorp/apollo/issues/483)
## 1.2 必选设置
Apollo客户端依赖于`AppId`,`Apollo Meta Server`等环境信息来工作,所以请确保阅读下面的说明并且做正确的配置:
### 1.2.1 AppId
AppId是应用的身份信息,是从服务端获取配置的一个重要信息。
有以下几种方式设置,按照优先级从高到低分别为:
1. System Property
Apollo 0.7.0+支持通过System Property传入app.id信息,如
```bash
-Dapp.id=YOUR-APP-ID
```
2. 操作系统的System Environment
Apollo 1.4.0+支持通过操作系统的System Environment `APP_ID`来传入app.id信息,如
```bash
APP_ID=YOUR-APP-ID
```
3. Spring Boot application.properties
Apollo 1.0.0+支持通过Spring Boot的application.properties文件配置,如
```properties
app.id=YOUR-APP-ID
```
> 该配置方式不适用于多个war包部署在同一个tomcat的使用场景
4. app.properties
确保classpath:/META-INF/app.properties文件存在,并且其中内容形如:
>app.id=YOUR-APP-ID
文件位置参考如下:
![app-id-location](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/app-id-location.png)
> 注:app.id是用来标识应用身份的唯一id,格式为string。
### 1.2.2 Apollo Meta Server
Apollo支持应用在不同的环境有不同的配置,所以需要在运行提供给Apollo客户端当前环境的[Apollo Meta Server](zh/design/apollo-design?id=_133-meta-server)信息。默认情况下,meta server和config service是部署在同一个JVM进程,所以meta server的地址就是config service的地址。
为了实现meta server的高可用,推荐通过SLB(Software Load Balancer)做动态负载均衡。Meta server地址也可以填入IP,如`http://1.1.1.1:8080,http://2.2.2.2:8080`,不过生产环境还是建议使用域名(走slb),因为机器扩容、缩容等都可能导致IP列表的变化。
1.0.0版本开始支持以下方式配置apollo meta server信息,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.meta`
* 可以通过Java的System Property `apollo.meta`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.meta=http://config-service-url`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.meta=http://config-service-url -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.meta", "http://config-service-url");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.meta=http://config-service-url`
> 该配置方式不适用于多个war包部署在同一个tomcat的使用场景
3. 通过操作系统的System Environment`APOLLO_META`
* 可以通过操作系统的System Environment `APOLLO_META`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.meta=http://config-service-url`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
5. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.meta=http://config-service-url`
6. 通过Java system property `${env}_meta`
* 如果当前[env](#_1241-environment)是`dev`,那么用户可以配置`-Ddev_meta=http://config-service-url`
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
7. 通过操作系统的System Environment `${ENV}_META` (1.2.0版本开始支持)
* 如果当前[env](#_1241-environment)是`dev`,那么用户可以配置操作系统的System Environment `DEV_META=http://config-service-url`
* 注意key为全大写
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
8. 通过`apollo-env.properties`文件
* 用户也可以创建一个`apollo-env.properties`,放在程序的classpath下,或者放在spring boot应用的config目录下
* 使用该配置方式,那么就必须要正确配置Environment,详见[1.2.4.1 Environment](#_1241-environment)
* 文件内容形如:
```properties
dev.meta=http://1.1.1.1:8080
fat.meta=http://apollo.fat.xxx.com
uat.meta=http://apollo.uat.xxx.com
pro.meta=http://apollo.xxx.com
```
> 如果通过以上各种手段都无法获取到Meta Server地址,Apollo最终会fallback到`http://apollo.meta`作为Meta Server地址
#### 1.2.2.1 自定义Apollo Meta Server地址定位逻辑
在1.0.0版本中,Apollo提供了[MetaServerProvider SPI](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/spi/MetaServerProvider.java),用户可以注入自己的MetaServerProvider来自定义Meta Server地址定位逻辑。
由于我们使用典型的[Java Service Loader模式](https://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html),所以实现起来还是比较简单的。
有一点需要注意的是,apollo会在运行时按照顺序遍历所有的MetaServerProvider,直到某一个MetaServerProvider提供了一个非空的Meta Server地址,因此用户需要格外注意自定义MetaServerProvider的Order。规则是较小的Order具有较高的优先级,因此Order=0的MetaServerProvider会排在Order=1的MetaServerProvider的前面。
**如果你的公司有很多应用需要接入Apollo,建议封装一个jar包,然后提供自定义的Apollo Meta Server定位逻辑,从而可以让接入Apollo的应用零配置使用。比如自己写一个`xx-company-apollo-client`,该jar包依赖`apollo-client`,在该jar包中通过spi方式定义自定义的MetaServerProvider实现,然后应用直接依赖`xx-company-apollo-client`即可。**
MetaServerProvider的实现可以参考[LegacyMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/internals/LegacyMetaServerProvider.java)和[DefaultMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultMetaServerProvider.java)。
#### 1.2.2.2 跳过Apollo Meta Server服务发现
> 适用于apollo-client 0.11.0及以上版本
一般情况下都建议使用Apollo的Meta Server机制来实现Config Service的服务发现,从而可以实现Config Service的高可用。不过apollo-client也支持跳过Meta Server服务发现,主要用于以下场景:
1. Config Service部署在公有云上,注册到Meta Server的是内网地址,本地开发环境无法直接连接
* 如果通过公网 SLB 对外暴露 Config Service的话,记得要设置 IP 白名单,避免数据泄露
2. Config Service部署在docker环境中,注册到Meta Server的是docker内网地址,本地开发环境无法直接连接
3. Config Service部署在kubernetes中,希望使用kubernetes自带的服务发现能力(Service)
针对以上场景,可以通过直接指定Config Service地址的方式来跳过Meta Server服务发现,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.configService`
* 可以通过Java的System Property `apollo.configService`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.configService=http://config-service-url:port`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.configService=http://config-service-url:port -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.configService", "http://config-service-url:port");`
2. 通过操作系统的System Environment`APOLLO_CONFIGSERVICE`
* 可以通过操作系统的System Environment `APOLLO_CONFIGSERVICE`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.configService=http://config-service-url:port`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
### 1.2.3 本地缓存路径
Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份,用于在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置,不影响应用正常运行。
本地缓存路径默认位于以下路径,所以请确保`/opt/data`或`C:\opt\data\`目录存在,且应用有读写权限。
* **Mac/Linux**: /opt/data/{_appId_}/config-cache
* **Windows**: C:\opt\data\\{_appId_}\config-cache
本地配置文件会以下面的文件名格式放置于本地缓存路径下:
**_{appId}+{cluster}+{namespace}.properties_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用的配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/client-local-cache.png)
文件内容以properties格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```properties
request.timeout=2000
batch=2000
```
#### 1.2.3.1 自定义缓存路径
1.0.0版本开始支持以下方式自定义缓存路径,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.cacheDir`
* 可以通过Java的System Property `apollo.cacheDir`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.cacheDir=/opt/data/some-cache-dir`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.cacheDir=/opt/data/some-cache-dir -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.cacheDir", "/opt/data/some-cache-dir");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.cacheDir=/opt/data/some-cache-dir`
3. 通过操作系统的System Environment`APOLLO_CACHEDIR`
* 可以通过操作系统的System Environment `APOLLO_CACHEDIR`来指定
* 注意key为全大写,且中间是`_`分隔
4. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`apollo.cacheDir=/opt/data/some-cache-dir`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
> 注:本地缓存路径也可用于容灾目录,如果应用在所有config service都挂掉的情况下需要扩容,那么也可以先把配置从已有机器上的缓存路径复制到新机器上的相同缓存路径
### 1.2.4 可选设置
#### 1.2.4.1 Environment
Environment可以通过以下3种方式的任意一个配置:
1. 通过Java System Property
* 可以通过Java的System Property `env`来指定环境
* 在Java程序启动脚本中,可以指定`-Denv=YOUR-ENVIRONMENT`
* 如果是运行jar文件,需要注意格式是`java -Denv=YOUR-ENVIRONMENT -jar xxx.jar`
* 注意key为全小写
2. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `ENV`来指定
* 注意key为全大写
3. 通过配置文件
* 最后一个推荐的方式是通过配置文件来指定`env=YOUR-ENVIRONMENT`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
文件内容形如:
```properties
env=DEV
```
目前,`env`支持以下几个值(大小写不敏感):
* DEV
* Development environment
* FAT
* Feature Acceptance Test environment
* UAT
* User Acceptance Test environment
* PRO
* Production environment
更多环境定义,可以参考[Env.java](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/Env.java)
#### 1.2.4.2 Cluster(集群)
Apollo支持配置按照集群划分,也就是说对于一个appId和一个环境,对不同的集群可以有不同的配置。
1.0.0版本开始支持以下方式集群,按照优先级从高到低分别为:
1. 通过Java System Property `apollo.cluster`
* 可以通过Java的System Property `apollo.cluster`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.cluster=SomeCluster`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.cluster=SomeCluster -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.cluster", "SomeCluster");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.cluster=SomeCluster`
3. 通过Java System Property
* 可以通过Java的System Property `idc`来指定环境
* 在Java程序启动脚本中,可以指定`-Didc=xxx`
* 如果是运行jar文件,需要注意格式是`java -Didc=xxx -jar xxx.jar`
* 注意key为全小写
4. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `IDC`来指定
* 注意key为全大写
5. 通过`server.properties`配置文件
* 可以在`server.properties`配置文件中指定`idc=xxx`
* 对于Mac/Linux,文件位置为`/opt/settings/server.properties`
* 对于Windows,文件位置为`C:\opt\settings\server.properties`
**Cluster Precedence**(集群顺序)
1. 如果`apollo.cluster`和`idc`同时指定:
* 我们会首先尝试从`apollo.cluster`指定的集群加载配置
* 如果没找到任何配置,会尝试从`idc`指定的集群加载配置
* 如果还是没找到,会从默认的集群(`default`)加载
2. 如果只指定了`apollo.cluster`:
* 我们会首先尝试从`apollo.cluster`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
3. 如果只指定了`idc`:
* 我们会首先尝试从`idc`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
4. 如果`apollo.cluster`和`idc`都没有指定:
* 我们会从默认的集群(`default`)加载配置
#### 1.2.4.3 设置内存中的配置项是否保持和页面上的顺序一致
> 适用于1.6.0及以上版本
默认情况下,apollo client内存中的配置存放在Properties中(底下是Hashtable),不会刻意保持和页面上看到的顺序一致,对绝大部分的场景是没有影响的。不过有些场景会强依赖配置项的顺序(如spring cloud zuul的路由规则),针对这种情况,可以开启OrderedProperties特性来使得内存中的配置顺序和页面上看到的一致。
配置方式按照优先级从高到低分别为:
1. 通过Java System Property `apollo.property.order.enable`
* 可以通过Java的System Property `apollo.property.order.enable`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.property.order.enable=true`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.property.order.enable=true -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.property.order.enable", "true");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.property.order.enable=true`
3. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.property.order.enable=true`
#### 1.2.4.4 配置访问密钥
> 适用于1.6.0及以上版本
Apollo从1.6.0版本开始增加访问密钥机制,从而只有经过身份验证的客户端才能访问敏感配置。如果应用开启了访问密钥,客户端需要配置密钥,否则无法获取配置。
配置方式按照优先级从高到低分别为:
1. 通过Java System Property `apollo.accesskey.secret`
* 可以通过Java的System Property `apollo.accesskey.secret`来指定
* 在Java程序启动脚本中,可以指定`-Dapollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
* 如果是运行jar文件,需要注意格式是`java -Dapollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719 -jar xxx.jar`
* 也可以通过程序指定,如`System.setProperty("apollo.accesskey.secret", "1cf998c4e2ad4704b45a98a509d15719");`
2. 通过Spring Boot的配置文件
* 可以在Spring Boot的`application.properties`或`bootstrap.properties`中指定`apollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
3. 通过操作系统的System Environment
* 还可以通过操作系统的System Environment `APOLLO_ACCESSKEY_SECRET`来指定
* 注意key为全大写
4. 通过`app.properties`配置文件
* 可以在`classpath:/META-INF/app.properties`指定`apollo.accesskey.secret=1cf998c4e2ad4704b45a98a509d15719`
# 二、Maven Dependency
Apollo的客户端jar包已经上传到中央仓库,应用在实际使用时只需要按照如下方式引入即可。
```xml
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>1.7.0</version>
</dependency>
```
# 三、客户端用法
Apollo支持API方式和Spring整合方式,该怎么选择用哪一种方式?
* API方式灵活,功能完备,配置值实时更新(热发布),支持所有Java环境。
* Spring方式接入简单,结合Spring有N种酷炫的玩法,如
* Placeholder方式:
* 代码中直接使用,如:`@Value("${someKeyFromApollo:someDefaultValue}")`
* 配置文件中使用替换placeholder,如:`spring.datasource.url: ${someKeyFromApollo:someDefaultValue}`
* 直接托管spring的配置,如在apollo中直接配置`spring.datasource.url=jdbc:mysql://localhost:3306/somedb?characterEncoding=utf8`
* Spring boot的[@ConfigurationProperties](http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/properties/ConfigurationProperties.html)方式
* 从v0.10.0开始的版本支持placeholder在运行时自动更新,具体参见[PR #972](https://github.com/ctripcorp/apollo/pull/972)。(v0.10.0之前的版本在配置变化后不会重新注入,需要重启才会更新,如果需要配置值实时更新,可以参考后续[3.2.2 Spring Placeholder的使用](#_322-spring-placeholder的使用)的说明)
* Spring方式也可以结合API方式使用,如注入Apollo的Config对象,就可以照常通过API方式获取配置了:
```java
@ApolloConfig
private Config config; //inject config for namespace application
```
* 更多有意思的实际使用场景和示例代码,请参考[apollo-use-cases](https://github.com/ctripcorp/apollo-use-cases)
## 3.1 API使用方式
API方式是最简单、高效使用Apollo配置的方式,不依赖Spring框架即可使用。
### 3.1.1 获取默认namespace的配置(application)
```java
Config config = ConfigService.getAppConfig(); //config instance is singleton for each namespace and is never null
String someKey = "someKeyFromDefaultNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
通过上述的**config.getProperty**可以获取到someKey对应的实时最新的配置值。
另外,配置值从内存中获取,所以不需要应用自己做缓存。
### 3.1.2 监听配置变化事件
监听配置变化事件只在应用真的关心配置变化,需要在配置变化时得到通知时使用,比如:数据库连接串变化后需要重建连接等。
如果只是希望每次都取到最新的配置的话,只需要按照上面的例子,调用**config.getProperty**即可。
```java
Config config = ConfigService.getAppConfig(); //config instance is singleton for each namespace and is never null
config.addChangeListener(new ConfigChangeListener() {
@Override
public void onChange(ConfigChangeEvent changeEvent) {
System.out.println("Changes for namespace " + changeEvent.getNamespace());
for (String key : changeEvent.changedKeys()) {
ConfigChange change = changeEvent.getChange(key);
System.out.println(String.format("Found change - key: %s, oldValue: %s, newValue: %s, changeType: %s", change.getPropertyName(), change.getOldValue(), change.getNewValue(), change.getChangeType()));
}
}
});
```
### 3.1.3 获取公共Namespace的配置
```java
String somePublicNamespace = "CAT";
Config config = ConfigService.getConfig(somePublicNamespace); //config instance is singleton for each namespace and is never null
String someKey = "someKeyFromPublicNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
### 3.1.4 获取非properties格式namespace的配置
#### 3.1.4.1 yaml/yml格式的namespace
apollo-client 1.3.0版本开始对yaml/yml做了更好的支持,使用起来和properties格式一致。
```java
Config config = ConfigService.getConfig("application.yml");
String someKey = "someKeyFromYmlNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);
```
#### 3.1.4.2 非yaml/yml格式的namespace
获取时需要使用`ConfigService.getConfigFile`接口并指定Format,如`ConfigFileFormat.XML`。
```java
String someNamespace = "test";
ConfigFile configFile = ConfigService.getConfigFile("test", ConfigFileFormat.XML);
String content = configFile.getContent();
```
## 3.2 Spring整合方式
### 3.2.1 配置
Apollo也支持和Spring整合(Spring 3.1.1+),只需要做一些简单的配置就可以了。
Apollo目前既支持比较传统的`基于XML`的配置,也支持目前比较流行的`基于Java(推荐)`的配置。
如果是Spring Boot环境,建议参照[3.2.1.3 Spring Boot集成方式(推荐)](#_3213-spring-boot集成方式(推荐))配置。
需要注意的是,如果之前有使用`org.springframework.beans.factory.config.PropertyPlaceholderConfigurer`的,请替换成`org.springframework.context.support.PropertySourcesPlaceholderConfigurer`。Spring 3.1以后就不建议使用PropertyPlaceholderConfigurer了,要改用PropertySourcesPlaceholderConfigurer。
如果之前有使用`<context:property-placeholder>`,请注意xml中引入的`spring-context.xsd`版本需要是3.1以上(一般只要没有指定版本会自动升级的),建议使用不带版本号的形式引入,如:`http://www.springframework.org/schema/context/spring-context.xsd`
> 注1:yaml/yml格式的namespace从1.3.0版本开始支持和Spring整合,注入时需要填写带后缀的完整名字,比如application.yml
> 注2:非properties、非yaml/yml格式(如xml,json等)的namespace暂不支持和Spring整合。
#### 3.2.1.1 基于XML的配置
>注:需要把apollo相关的xml namespace加到配置文件头上,不然会报xml语法错误。
1.注入默认namespace的配置到Spring中
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<!-- 这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中 -->
<apollo:config/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
2.注入多个namespace的配置到Spring中
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<!-- 这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中 -->
<apollo:config/>
<!-- 这个是稍微复杂一些的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中 -->
<apollo:config namespaces="FX.apollo,application.yml"/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
3.注入多个namespace,并且指定顺序
Spring的配置是有顺序的,如果多个property source都有同一个key,那么最终是顺序在前的配置生效。
<apollo:config>如果不指定order,那么默认是最低优先级。
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<apollo:config order="2"/>
<!-- 这个是最复杂的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中,并且顺序在application前面 -->
<apollo:config namespaces="FX.apollo,application.yml" order="1"/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
#### 3.2.1.2 基于Java的配置(推荐)
相对于基于XML的配置,基于Java的配置是目前比较流行的方式。
注意`@EnableApolloConfig`要和`@Configuration`一起使用,不然不会生效。
1.注入默认namespace的配置到Spring中
```java
//这个是最简单的配置形式,一般应用用这种形式就可以了,用来指示Apollo注入application namespace的配置到Spring环境中
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
```
2.注入多个namespace的配置到Spring中
```java
@Configuration
@EnableApolloConfig
public class SomeAppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
//这个是稍微复杂一些的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中
@Configuration
@EnableApolloConfig({"FX.apollo", "application.yml"})
public class AnotherAppConfig {}
```
3.注入多个namespace,并且指定顺序
```java
//这个是最复杂的配置形式,指示Apollo注入FX.apollo和application.yml namespace的配置到Spring环境中,并且顺序在application前面
@Configuration
@EnableApolloConfig(order = 2)
public class SomeAppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
@Configuration
@EnableApolloConfig(value = {"FX.apollo", "application.yml"}, order = 1)
public class AnotherAppConfig {}
```
#### 3.2.1.3 Spring Boot集成方式(推荐)
Spring Boot除了支持上述两种集成方式以外,还支持通过application.properties/bootstrap.properties来配置,该方式能使配置在更早的阶段注入,比如使用`@ConditionalOnProperty`的场景或者是有一些spring-boot-starter在启动阶段就需要读取配置做一些事情(如[dubbo-spring-boot-project](https://github.com/apache/incubator-dubbo-spring-boot-project)),所以对于Spring Boot环境建议通过以下方式来接入Apollo(需要0.10.0及以上版本)。
使用方式很简单,只需要在application.properties/bootstrap.properties中按照如下样例配置即可。
1. 注入默认`application` namespace的配置示例
```properties
# will inject 'application' namespace in bootstrap phase
apollo.bootstrap.enabled = true
```
2. 注入非默认`application` namespace或多个namespace的配置示例
```properties
apollo.bootstrap.enabled = true
# will inject 'application', 'FX.apollo' and 'application.yml' namespaces in bootstrap phase
apollo.bootstrap.namespaces = application,FX.apollo,application.yml
```
3. 将Apollo配置加载提到初始化日志系统之前(1.2.0+)
从1.2.0版本开始,如果希望把日志相关的配置(如`logging.level.root=info`或`logback-spring.xml`中的参数)也放在Apollo管理,那么可以额外配置`apollo.bootstrap.eagerLoad.enabled=true`来使Apollo的加载顺序放到日志系统加载之前,不过这会导致Apollo的启动过程无法通过日志的方式输出(因为执行Apollo加载的时候,日志系统压根没有准备好呢!所以在Apollo代码中使用Slf4j的日志输出便没有任何内容),更多信息可以参考[PR 1614](https://github.com/ctripcorp/apollo/pull/1614)。参考配置示例如下:
```properties
# will inject 'application' namespace in bootstrap phase
apollo.bootstrap.enabled = true
# put apollo initialization before logging system initialization
apollo.bootstrap.eagerLoad.enabled=true
```
### 3.2.2 Spring Placeholder的使用
Spring应用通常会使用Placeholder来注入配置,使用的格式形如${someKey:someDefaultValue},如${timeout:100}。冒号前面的是key,冒号后面的是默认值。
建议在实际使用时尽量给出默认值,以免由于key没有定义导致运行时错误。
从v0.10.0开始的版本支持placeholder在运行时自动更新,具体参见[PR #972](https://github.com/ctripcorp/apollo/pull/972)。
如果需要关闭placeholder在运行时自动更新功能,可以通过以下两种方式关闭:
1. 通过设置System Property `apollo.autoUpdateInjectedSpringProperties`,如启动时传入`-Dapollo.autoUpdateInjectedSpringProperties=false`
2. 通过设置META-INF/app.properties中的`apollo.autoUpdateInjectedSpringProperties`属性,如
```properties
app.id=SampleApp
apollo.autoUpdateInjectedSpringProperties=false
```
#### 3.2.2.1 XML使用方式
假设我有一个TestXmlBean,它有两个配置项需要注入:
```java
public class TestXmlBean {
private int timeout;
private int batch;
public void setTimeout(int timeout) {
this.timeout = timeout;
}
public void setBatch(int batch) {
this.batch = batch;
}
public int getTimeout() {
return timeout;
}
public int getBatch() {
return batch;
}
}
```
那么,我在XML中会使用如下方式来定义(假设应用默认的application namespace中有timeout和batch的配置项):
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:apollo="http://www.ctrip.com/schema/apollo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.ctrip.com/schema/apollo http://www.ctrip.com/schema/apollo.xsd">
<apollo:config/>
<bean class="com.ctrip.framework.apollo.spring.TestXmlBean">
<property name="timeout" value="${timeout:100}"/>
<property name="batch" value="${batch:200}"/>
</bean>
</beans>
```
#### 3.2.2.2 Java Config使用方式
假设我有一个TestJavaConfigBean,通过Java Config的方式还可以使用@Value的方式注入:
```java
public class TestJavaConfigBean {
@Value("${timeout:100}")
private int timeout;
private int batch;
@Value("${batch:200}")
public void setBatch(int batch) {
this.batch = batch;
}
public int getTimeout() {
return timeout;
}
public int getBatch() {
return batch;
}
}
```
在Configuration类中按照下面的方式使用(假设应用默认的application namespace中有`timeout`和`batch`的配置项):
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestJavaConfigBean javaConfigBean() {
return new TestJavaConfigBean();
}
}
```
#### 3.2.2.3 ConfigurationProperties使用方式
Spring Boot提供了[@ConfigurationProperties](http://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/context/properties/ConfigurationProperties.html)把配置注入到bean对象中。
Apollo也支持这种方式,下面的例子会把`redis.cache.expireSeconds`和`redis.cache.commandTimeout`分别注入到SampleRedisConfig的`expireSeconds`和`commandTimeout`字段中。
```java
@ConfigurationProperties(prefix = "redis.cache")
public class SampleRedisConfig {
private int expireSeconds;
private int commandTimeout;
public void setExpireSeconds(int expireSeconds) {
this.expireSeconds = expireSeconds;
}
public void setCommandTimeout(int commandTimeout) {
this.commandTimeout = commandTimeout;
}
}
```
在Configuration类中按照下面的方式使用(假设应用默认的application namespace中有`redis.cache.expireSeconds`和`redis.cache.commandTimeout`的配置项):
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public SampleRedisConfig sampleRedisConfig() {
return new SampleRedisConfig();
}
}
```
需要注意的是,`@ConfigurationProperties`如果需要在Apollo配置变化时自动更新注入的值,需要配合使用[EnvironmentChangeEvent](https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_environment_changes)或[RefreshScope](https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_refresh_scope)。相关代码实现,可以参考apollo-use-cases项目中的[ZuulPropertiesRefresher.java](https://github.com/ctripcorp/apollo-use-cases/blob/master/spring-cloud-zuul/src/main/java/com/ctrip/framework/apollo/use/cases/spring/cloud/zuul/ZuulPropertiesRefresher.java#L48)和apollo-demo项目中的[SampleRedisConfig.java](https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/config/SampleRedisConfig.java)以及[SpringBootApolloRefreshConfig.java](https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/refresh/SpringBootApolloRefreshConfig.java)
### 3.2.3 Spring Annotation支持
Apollo同时还增加了几个新的Annotation来简化在Spring环境中的使用。
1. @ApolloConfig
* 用来自动注入Config对象
2. @ApolloConfigChangeListener
* 用来自动注册ConfigChangeListener
3. @ApolloJsonValue
* 用来把配置的json字符串自动注入为对象
使用样例如下:
```java
public class TestApolloAnnotationBean {
@ApolloConfig
private Config config; //inject config for namespace application
@ApolloConfig("application")
private Config anotherConfig; //inject config for namespace application
@ApolloConfig("FX.apollo")
private Config yetAnotherConfig; //inject config for namespace FX.apollo
@ApolloConfig("application.yml")
private Config ymlConfig; //inject config for namespace application.yml
/**
* ApolloJsonValue annotated on fields example, the default value is specified as empty list - []
* <br />
* jsonBeanProperty=[{"someString":"hello","someInt":100},{"someString":"world!","someInt":200}]
*/
@ApolloJsonValue("${jsonBeanProperty:[]}")
private List<JsonBean> anotherJsonBeans;
@Value("${batch:100}")
private int batch;
//config change listener for namespace application
@ApolloConfigChangeListener
private void someOnChange(ConfigChangeEvent changeEvent) {
//update injected value of batch if it is changed in Apollo
if (changeEvent.isChanged("batch")) {
batch = config.getIntProperty("batch", 100);
}
}
//config change listener for namespace application
@ApolloConfigChangeListener("application")
private void anotherOnChange(ConfigChangeEvent changeEvent) {
//do something
}
//config change listener for namespaces application, FX.apollo and application.yml
@ApolloConfigChangeListener({"application", "FX.apollo", "application.yml"})
private void yetAnotherOnChange(ConfigChangeEvent changeEvent) {
//do something
}
//example of getting config from Apollo directly
//this will always return the latest value of timeout
public int getTimeout() {
return config.getIntProperty("timeout", 200);
}
//example of getting config from injected value
//the program needs to update the injected value when batch is changed in Apollo using @ApolloConfigChangeListener shown above
public int getBatch() {
return this.batch;
}
private static class JsonBean{
private String someString;
private int someInt;
}
}
```
在Configuration类中按照下面的方式使用:
```java
@Configuration
@EnableApolloConfig
public class AppConfig {
@Bean
public TestApolloAnnotationBean testApolloAnnotationBean() {
return new TestApolloAnnotationBean();
}
}
```
### 3.2.4 已有配置迁移
很多情况下,应用可能已经有不少配置了,比如Spring Boot的应用,就会有bootstrap.properties/yml, application.properties/yml等配置。
在应用接入Apollo之后,这些配置是可以非常方便的迁移到Apollo的,具体步骤如下:
1. 在Apollo为应用新建项目
2. 在应用中配置好META-INF/app.properties
3. 建议把原先配置先转为properties格式,然后通过Apollo提供的文本编辑模式全部粘帖到应用的application namespace,发布配置
* 如果原来格式是yml,可以使用[YamlPropertiesFactoryBean.getObject](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.html#getObject--)转成properties格式
4. 如果原来是yml,想继续使用yml来编辑配置,那么可以创建私有的application.yml namespace,把原来的配置全部粘贴进去,发布配置
* 需要apollo-client是1.3.0及以上版本
5. 把原先的配置文件如bootstrap.properties/yml, application.properties/yml从项目中删除
* 如果需要保留本地配置文件,需要注意部分配置如`server.port`必须确保本地文件已经删除该配置项
如:
```properties
spring.application.name = reservation-service
server.port = 8080
logging.level = ERROR
eureka.client.serviceUrl.defaultZone = http://127.0.0.1:8761/eureka/
eureka.client.healthcheck.enabled = true
eureka.client.registerWithEureka = true
eureka.client.fetchRegistry = true
eureka.client.eurekaServiceUrlPollIntervalSeconds = 60
eureka.instance.preferIpAddress = true
```
![text-mode-spring-boot-config-sample](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-spring-boot-config-sample.png)
## 3.3 Demo
项目中有一个样例客户端的项目:`apollo-demo`,具体信息可以参考[Apollo开发指南](zh/development/apollo-development-guide)中的[2.3 Java样例客户端启动](zh/development/apollo-development-guide?id=_23-java样例客户端启动)部分。
更多使用案例Demo可以参考[Apollo使用场景和示例代码](https://github.com/ctripcorp/apollo-use-cases)。
# 四、客户端设计
![client-architecture](https://github.com/ctripcorp/apollo/raw/master/doc/images/client-architecture.png)
上图简要描述了Apollo客户端的实现原理:
1. 客户端和服务端保持了一个长连接,从而能第一时间获得配置更新的推送。(通过Http Long Polling实现)
2. 客户端还会定时从Apollo配置中心服务端拉取应用的最新配置。
* 这是一个fallback机制,为了防止推送机制失效导致配置不更新
* 客户端定时拉取会上报本地版本,所以一般情况下,对于定时拉取的操作,服务端都会返回304 - Not Modified
* 定时频率默认为每5分钟拉取一次,客户端也可以通过在运行时指定System Property: `apollo.refreshInterval`来覆盖,单位为分钟。
3. 客户端从Apollo配置中心服务端获取到应用的最新配置后,会保存在内存中
4. 客户端会把从服务端获取到的配置在本地文件系统缓存一份
* 在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置
5. 应用程序可以从Apollo客户端获取最新的配置、订阅配置更新通知
# 五、本地开发模式
Apollo客户端还支持本地开发模式,这个主要用于当开发环境无法连接Apollo服务器的时候,比如在邮轮、飞机上做相关功能开发。
在本地开发模式下,Apollo只会从本地文件读取配置信息,不会从Apollo服务器读取配置。
可以通过下面的步骤开启Apollo本地开发模式。
## 5.1 修改环境
修改/opt/settings/server.properties(Mac/Linux)或C:\opt\settings\server.properties(Windows)文件,设置env为Local:
```properties
env=Local
```
更多配置环境的方式请参考[1.2.4.1 Environment](#_1241-environment)
## 5.2 准备本地配置文件
在本地开发模式下,Apollo客户端会从本地读取文件,所以我们需要事先准备好配置文件。
### 5.2.1 本地配置目录
本地配置目录位于:
* **Mac/Linux**: /opt/data/{_appId_}/config-cache
* **Windows**: C:\opt\data\\{_appId_}\config-cache
appId就是应用的appId,如100004458。
请确保该目录存在,且应用程序对该目录有读权限。
**【小技巧】** 推荐的方式是先在普通模式下使用Apollo,这样Apollo会自动创建该目录并在目录下生成配置文件。
### 5.2.2 本地配置文件
本地配置文件需要按照一定的文件名格式放置于本地配置目录下,文件名格式如下:
**_{appId}+{cluster}+{namespace}.properties_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用的配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-client/doc/pic/client-local-cache.png)
文件内容以properties格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```properties
request.timeout=2000
batch=2000
```
## 5.3 修改配置
在本地开发模式下,Apollo不会实时监测文件内容是否有变化,所以如果修改了配置,需要重启应用生效。
# 六、测试模式
1.1.0版本开始增加了`apollo-mockserver`,从而可以很好地支持单元测试时需要mock配置的场景,使用方法如下:
## 6.1 引入pom依赖
```xml
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-mockserver</artifactId>
<version>1.7.0</version>
</dependency>
```
## 6.2 在test的resources下放置mock的数据
文件名格式约定为`mockdata-{namespace}.properties`
![image](https://user-images.githubusercontent.com/17842829/44515526-5e0e6480-a6f5-11e8-9c3c-4ff2ec737c8d.png)
## 6.3 写测试类
更多使用demo可以参考[ApolloMockServerApiTest.java](https://github.com/ctripcorp/apollo/blob/master/apollo-mockserver/src/test/java/com/ctrip/framework/apollo/mockserver/ApolloMockServerApiTest.java)和[ApolloMockServerSpringIntegrationTest.java](https://github.com/ctripcorp/apollo/blob/master/apollo-mockserver/src/test/java/com/ctrip/framework/apollo/mockserver/ApolloMockServerSpringIntegrationTest.java)。
```java
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = TestConfiguration.class)
public class SpringIntegrationTest {
// 启动apollo的mockserver
@ClassRule
public static EmbeddedApollo embeddedApollo = new EmbeddedApollo();
@Test
@DirtiesContext // 这个注解很有必要,因为配置注入会弄脏应用上下文
public void testPropertyInject(){
assertEquals("value1", testBean.key1);
assertEquals("value2", testBean.key2);
}
@Test
@DirtiesContext
public void testListenerTriggeredByAdd() throws InterruptedException, ExecutionException, TimeoutException {
String otherNamespace = "othernamespace";
embeddedApollo.addOrModifyPropery(otherNamespace,"someKey","someValue");
ConfigChangeEvent changeEvent = testBean.futureData.get(5000, TimeUnit.MILLISECONDS);
assertEquals(otherNamespace, changeEvent.getNamespace());
assertEquals("someValue", changeEvent.getChange("someKey").getNewValue());
}
@EnableApolloConfig("application")
@Configuration
static class TestConfiguration{
@Bean
public TestBean testBean(){
return new TestBean();
}
}
static class TestBean{
@Value("${key1:default}")
String key1;
@Value("${key2:default}")
String key2;
SettableFuture<ConfigChangeEvent> futureData = SettableFuture.create();
@ApolloConfigChangeListener("othernamespace")
private void onChange(ConfigChangeEvent changeEvent) {
futureData.set(changeEvent);
}
}
}
```
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./SECURITY.md | # Security Policy
## Reporting a Vulnerability
If you have apprehensions regarding Apollo's security or you discover vulnerability or potential threat, don’t hesitate to report it to one of the active [project maintainers](https://github.com/ctripcorp/apollo/graphs/contributors).
In the mail, specify the description of the issue or potential threat. You are also urged to recommend the way to reproduce and replicate the issue. The Apollo community will get back to you after assessing and analysing the findings.
PLEASE PAY ATTENTION to report the security issue on the security email before disclosing it on public domain.
| # Security Policy
## Reporting a Vulnerability
If you have apprehensions regarding Apollo's security or you discover vulnerability or potential threat, don’t hesitate to report it to one of the active [project maintainers](https://github.com/ctripcorp/apollo/graphs/contributors).
In the mail, specify the description of the issue or potential threat. You are also urged to recommend the way to reproduce and replicate the issue. The Apollo community will get back to you after assessing and analysing the findings.
PLEASE PAY ATTENTION to report the security issue on the security email before disclosing it on public domain.
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/en/_sidebar.md | - Getting started
- [Quick start](en/quick-start.md)
- [Releases](https://github.com/ctripcorp/apollo/releases) | - Getting started
- [Quick start](en/quick-start.md)
- [Releases](https://github.com/ctripcorp/apollo/releases) | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/faq/common-issues-in-deployment-and-development-phase.md | ### 1. windows怎么执行build.sh?
安装[Git Bash](https://git-for-windows.github.io/),然后运行 “./build.sh” 注意前面 “./”
### 2. 本地运行时Portal一直报Env is down.
默认config service启动在8080端口,admin service启动在8090端口。请确认这两个端口是否被其它应用程序占用。
如果还伴有异常信息:org.springframework.web.client.HttpClientErrorException: 405 Method Not Allowed,一般是由于本地启动了`ShadowSocks`,因为`ShadowSocks`默认会占用8090端口。
1.1.0版本增加了**系统信息**页面,可以通过`管理员工具` -> `系统信息`查看当前各个环境的Meta Server以及admin service信息,有助于排查问题。
### 3. admin server 或者 config server 注册了内网IP,导致portal或者client访问不了admin server或config server
分布式部署的时候,`apollo-configservice`和`apollo-adminservice`需要把自己的IP和端口注册到Meta Server(apollo-configservice本身)。
Apollo客户端和Portal会从Meta Server获取服务的地址(IP+端口),然后通过服务地址直接访问。
所以如果实际部署的机器有多块网卡(如docker),或者存在某些网卡的IP是Apollo客户端和Portal无法访问的(如网络安全限制),那么我们就需要在`apollo-configservice`和`apollo-adminservice`中做相关限制以避免Eureka将这些网卡的IP注册到Meta Server。
#### 方案一: 忽略某些网卡
具体文档可以参考[Ignore Network Interfaces](http://projects.spring.io/spring-cloud/spring-cloud.html#ignore-network-interfaces)章节。具体而言,就是分别编辑[apollo-configservice/src/main/resources/application.yml](https://github.com/ctripcorp/apollo/blob/master/apollo-configservice/src/main/resources/application.yml)和[apollo-adminservice/src/main/resources/application.yml](https://github.com/ctripcorp/apollo/blob/master/apollo-adminservice/src/main/resources/application.yml),然后把需要忽略的网卡加进去。
如下面这个例子就是对于`apollo-configservice`,把docker0和veth.*的网卡在注册到Eureka时忽略掉。
```yaml
spring:
application:
name: apollo-configservice
profiles:
active: ${apollo_profile}
cloud:
inetutils:
ignoredInterfaces:
- docker0
- veth.*
```
> 注意,对于application.yml修改时要小心,千万不要把其它信息改错了,如spring.application.name等。
#### 方案二:强制指定admin server和config server向eureka注册的IP
可以修改startup.sh,通过JVM System Property在运行时传入,如`-Deureka.instance.ip-address=${指定的IP}`,或者也可以修改apollo-adminservice或apollo-configservice 的bootstrap.yml文件,加入以下配置
``` yaml
eureka:
instance:
ip-address: ${指定的IP}
```
#### 方案三:强制指定admin server和config server向eureka注册的IP和Port
可以修改startup.sh,通过JVM System Property在运行时传入,如`-Deureka.instance.homePageUrl=http://${指定的IP}:${指定的Port}`,或者也可以修改apollo-adminservice或apollo-configservice 的bootstrap.yml文件,加入以下配置
``` yaml
eureka:
instance:
homePageUrl: http://${指定的IP}:${指定的Port}
preferIpAddress: false
```
做完上述修改并重启后,可以查看Eureka页面(http://${config-service-url:port})检查注册上来的IP信息是否正确。
> 注:如果Apollo部署在公有云上,本地开发环境无法连接,但又需要做开发测试的话,客户端可以升级到0.11.0版本及以上,然后通过`-Dapollo.configService=http://config-service的公网IP:端口`来跳过meta service的服务发现,记得要对公网 SLB 设置 IP 白名单,避免数据泄露
### 4. Portal如何增加环境?
#### 4.1 1.6.0及以上的版本
1.6.0版本增加了自定义环境的功能,可以在不修改代码的情况增加环境
1. protaldb增加环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
2. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
#### 4.2 1.5.1及之前的版本
##### 4.2.1 添加Apollo预先定义好的环境
如果需要添加的环境是Apollo预先定义的环境(DEV, FAT, UAT, PRO),需要两步操作:
1. protaldb增加环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
2. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
##### 4.2.2 添加自定义的环境
如果需要添加的环境不是Apollo预先定义的环境,请参照如下步骤操作:
1. 假设需要添加的环境名称叫beta
2. 修改[com.ctrip.framework.apollo.core.enums.Env](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/Env.java)类,在其中加入`BETA`枚举:
```java
public enum Env{
LOCAL, DEV, BETA, FWS, FAT, UAT, LPT, PRO, TOOLS, UNKNOWN;
...
}
```
3. 修改[com.ctrip.framework.apollo.core.enums.EnvUtils](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/EnvUtils.java)类,在其中加入`BETA`枚举的转换逻辑:
```java
public final class EnvUtils {
public static Env transformEnv(String envName) {
if (StringUtils.isBlank(envName)) {
return Env.UNKNOWN;
}
switch (envName.trim().toUpperCase()) {
...
case "BETA":
return Env.BETA;
...
default:
return Env.UNKNOWN;
}
}
}
```
4. 修改[apollo-env.properties](https://github.com/ctripcorp/apollo/blob/master/apollo-portal/src/main/resources/apollo-env.properties),增加`beta.meta`占位符:
```properties
local.meta=http://localhost:8080
dev.meta=${dev_meta}
fat.meta=${fat_meta}
beta.meta=${beta_meta}
uat.meta=${uat_meta}
lpt.meta=${lpt_meta}
pro.meta=${pro_meta}
```
5. 修改[com.ctrip.framework.apollo.core.internals.LegacyMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/internals/LegacyMetaServerProvider.java)类,增加读取`BETA`环境的meta server地址逻辑:
```java
public class LegacyMetaServerProvider {
...
domains.put(Env.BETA, getMetaServerAddress(prop, "beta_meta", "beta.meta"));
...
}
```
6. protaldb增加`BETA`环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
7. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
### 5. 如何删除应用、集群、Namespace?
0.11.0版本开始Apollo管理员增加了删除应用、集群和AppNamespace的页面,建议使用该页面进行删除。
页面入口:
![delete-app-cluster-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/delete-app-cluster-namespace-entry.png)
页面详情:
![delete-app-cluster-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/delete-app-cluster-namespace-detail.png)
### 6. 客户端多块网卡造成获取IP不准,如何解决?
获取客户端网卡逻辑在1.4.0版本有所调整,所以需要根据客户端版本区分
#### 6.1 apollo-client为1.3.0及之前的版本
如果有多网卡,且都是普通网卡的话,需要在/etc/hosts里面加一条映射关系来提升权重。
格式:`ip ${hostname}`
这里的${hostname}就是你在机器上执行hostname的结果。
比如正确IP为:192.168.1.50,hostname执行结果为:jim-ubuntu-pc
那么最终在hosts文件映射的记录为:
```
192.168.1.50 jim-ubuntu-pc
```
#### 6.2 apollo-client为1.4.0及之后的版本
如果有多网卡,且都是普通网卡的话,可以通过调整它们在系统中的顺序来改变优先级,顺序在前的优先级更高。
### 7. 通过Apollo动态调整Spring Boot的Logging level
可以参考[apollo-use-cases](https://github.com/ctripcorp/apollo-use-cases)项目中的[spring-cloud-logger](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-cloud-logger)和[spring-boot-logger](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-boot-logger)代码示例。
### 8. 将Config Service和Admin Service注册到单独的Eureka Server上
Apollo默认自带了Eureka作为内部的注册中心实现,一般情况下不需要考虑为Apollo单独部署注册中心。
不过有些公司自己已经有了一套Eureka,如果希望把Apollo的Config Service和Admin Service也注册过去实现统一管理的话,可以按照如下步骤操作:
#### 1. 配置Config Service不启动内置Eureka Server
##### 1.1 1.5.0及以上版本
为apollo-configservice配置`apollo.eureka.server.enabled=false`即可,通过bootstrap.yml或-D参数等方式皆可。
##### 1.2 1.5.0之前的版本
修改[com.ctrip.framework.apollo.configservice.ConfigServiceApplication](https://github.com/ctripcorp/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/ConfigServiceApplication.java),把`@EnableEurekaServer`改为`@EnableEurekaClient`
```java
@EnableEurekaClient
@EnableAspectJAutoProxy
@EnableAutoConfiguration // (exclude = EurekaClientConfigBean.class)
@Configuration
@EnableTransactionManagement
@PropertySource(value = {"classpath:configservice.properties"})
@ComponentScan(basePackageClasses = {ApolloCommonConfig.class,
ApolloBizConfig.class,
ConfigServiceApplication.class,
ApolloMetaServiceConfig.class})
public class ConfigServiceApplication {
...
}
```
#### 2. 修改ApolloConfigDB.ServerConfig表中的`eureka.service.url`,指向自己的Eureka地址
比如自己的Eureka服务地址是1.1.1.1:8761和2.2.2.2:8761,那么就将ApolloConfigDB.ServerConfig表中设置eureka.service.url为:
```
http://1.1.1.1:8761/eureka/,http://2.2.2.2:8761/eureka/
```
需要注意的是更改Eureka地址只需要改ApolloConfigDB.ServerConfig表中的`eureka.service.url`即可,不需要修改meta server地址。
> 默认情况下,meta service和config service是部署在同一个JVM进程,所以meta service的地址就是config service的地址,修改Eureka地址时不需要修改meta server地址。
### 9. Spring Boot中使用`ConditionalOnProperty`读取不到配置
`@ConditionalOnProperty`功能从0.10.0版本开始支持,具体可以参考 [Spring Boot集成方式](zh/usage/java-sdk-user-guide?id=_3213-spring-boot集成方式(推荐))
### 10. 多机房如何实现A机房的客户端就近读取A机房的config service,B机房的客户端就近读取B机房的config service?
请参考[Issue 1294](https://github.com/ctripcorp/apollo/issues/1294),该案例中由于中美机房相距甚远,所以需要config db两地部署,如果是同城多机房的话,两个机房的config service可以连同一个config db。
### 11. apollo是否有支持HEAD请求的页面?阿里云slb配置健康检查只支持HEAD请求
apollo的每个服务都有`/health`页面的,该页面是apollo用来做健康检测的,支持各种请求方法,如GET, POST, HEAD等。
### 12. apollo如何配置查看权限?
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
### 13. apollo如何放在独立的tomcat中跑?
有些公司的运维策略可能会要求必须使用独立的tomcat跑应用,不允许apollo默认的startup.sh方式运行,下面以apollo-configservice为例简述一下如何使apollo服务端运行在独立的tomcat中:
1. 获取apollo代码(生产部署建议用release的版本)
2. 修改apollo-configservice的pom.xml,增加`<packaging>war</packaging>`
3. 按照分布式部署文档配置build.sh,然后打包
4. 把apollo-configservice的war包放到tomcat下
* cp apollo-configservice/target/apollo-configservice-xxx.war ${tomcat-dir}/webapps/ROOT.war
运行tomcat的startup.sh
5. 运行tomcat的startup.sh
另外,apollo还有一些调优参数建议在tomcat的server.xml中配置一下,可以参考[application.properties](https://github.com/ctripcorp/apollo/blob/master/apollo-common/src/main/resources/application.properties#L12)
### 14. 注册中心Eureka如何替换为zookeeper?
许多公司微服务项目已经在使用zookeeper,如果出于方便服务管理的目的,希望Eureka替换为zookeeper的情况,可以参考[@hanyidreamer](https://github.com/hanyidreamer)贡献的改造步骤:[注册中心Eureka替换为zookeeper](https://blog.csdn.net/u014732209/article/details/89555535)
### 15. 本地多人同时开发,如何实现配置不一样且互不影响?
参考[#1560](https://github.com/ctripcorp/apollo/issues/1560)
### 16. Portal挂载到nginx/slb后如何设置相对路径?
一般情况下建议直接使用根目录来挂载portal,不过如果有些情况希望和其它应用共用nginx/slb,需要加上相对路径(如/apollo),那么可以按照下面的方式配置。
#### 16.1 Portal为1.7.0及以上版本
首先为apollo-portal增加-D参数`server.servlet.context-path=/apollo`或系统环境变量`SERVER_SERVLET_CONTEXT_PATH=/apollo`。
然后在nginx/slb上配置转发即可,以nginx为例:
```
location /apollo/ {
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://127.0.0.1:8070/apollo/;
}
```
#### 16.2 Portal为1.6.0及以上版本
首先为portal加上`prefix.path=/apollo`配置参数,配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`prefix.path`配置项即可。
然后在nginx/slb上配置转发即可,以nginx为例:
```
location /apollo/ {
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://127.0.0.1:8070/;
}
``` | ### 1. windows怎么执行build.sh?
安装[Git Bash](https://git-for-windows.github.io/),然后运行 “./build.sh” 注意前面 “./”
### 2. 本地运行时Portal一直报Env is down.
默认config service启动在8080端口,admin service启动在8090端口。请确认这两个端口是否被其它应用程序占用。
如果还伴有异常信息:org.springframework.web.client.HttpClientErrorException: 405 Method Not Allowed,一般是由于本地启动了`ShadowSocks`,因为`ShadowSocks`默认会占用8090端口。
1.1.0版本增加了**系统信息**页面,可以通过`管理员工具` -> `系统信息`查看当前各个环境的Meta Server以及admin service信息,有助于排查问题。
### 3. admin server 或者 config server 注册了内网IP,导致portal或者client访问不了admin server或config server
分布式部署的时候,`apollo-configservice`和`apollo-adminservice`需要把自己的IP和端口注册到Meta Server(apollo-configservice本身)。
Apollo客户端和Portal会从Meta Server获取服务的地址(IP+端口),然后通过服务地址直接访问。
所以如果实际部署的机器有多块网卡(如docker),或者存在某些网卡的IP是Apollo客户端和Portal无法访问的(如网络安全限制),那么我们就需要在`apollo-configservice`和`apollo-adminservice`中做相关限制以避免Eureka将这些网卡的IP注册到Meta Server。
#### 方案一: 忽略某些网卡
具体文档可以参考[Ignore Network Interfaces](http://projects.spring.io/spring-cloud/spring-cloud.html#ignore-network-interfaces)章节。具体而言,就是分别编辑[apollo-configservice/src/main/resources/application.yml](https://github.com/ctripcorp/apollo/blob/master/apollo-configservice/src/main/resources/application.yml)和[apollo-adminservice/src/main/resources/application.yml](https://github.com/ctripcorp/apollo/blob/master/apollo-adminservice/src/main/resources/application.yml),然后把需要忽略的网卡加进去。
如下面这个例子就是对于`apollo-configservice`,把docker0和veth.*的网卡在注册到Eureka时忽略掉。
```yaml
spring:
application:
name: apollo-configservice
profiles:
active: ${apollo_profile}
cloud:
inetutils:
ignoredInterfaces:
- docker0
- veth.*
```
> 注意,对于application.yml修改时要小心,千万不要把其它信息改错了,如spring.application.name等。
#### 方案二:强制指定admin server和config server向eureka注册的IP
可以修改startup.sh,通过JVM System Property在运行时传入,如`-Deureka.instance.ip-address=${指定的IP}`,或者也可以修改apollo-adminservice或apollo-configservice 的bootstrap.yml文件,加入以下配置
``` yaml
eureka:
instance:
ip-address: ${指定的IP}
```
#### 方案三:强制指定admin server和config server向eureka注册的IP和Port
可以修改startup.sh,通过JVM System Property在运行时传入,如`-Deureka.instance.homePageUrl=http://${指定的IP}:${指定的Port}`,或者也可以修改apollo-adminservice或apollo-configservice 的bootstrap.yml文件,加入以下配置
``` yaml
eureka:
instance:
homePageUrl: http://${指定的IP}:${指定的Port}
preferIpAddress: false
```
做完上述修改并重启后,可以查看Eureka页面(http://${config-service-url:port})检查注册上来的IP信息是否正确。
> 注:如果Apollo部署在公有云上,本地开发环境无法连接,但又需要做开发测试的话,客户端可以升级到0.11.0版本及以上,然后通过`-Dapollo.configService=http://config-service的公网IP:端口`来跳过meta service的服务发现,记得要对公网 SLB 设置 IP 白名单,避免数据泄露
### 4. Portal如何增加环境?
#### 4.1 1.6.0及以上的版本
1.6.0版本增加了自定义环境的功能,可以在不修改代码的情况增加环境
1. protaldb增加环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
2. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
#### 4.2 1.5.1及之前的版本
##### 4.2.1 添加Apollo预先定义好的环境
如果需要添加的环境是Apollo预先定义的环境(DEV, FAT, UAT, PRO),需要两步操作:
1. protaldb增加环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
2. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
##### 4.2.2 添加自定义的环境
如果需要添加的环境不是Apollo预先定义的环境,请参照如下步骤操作:
1. 假设需要添加的环境名称叫beta
2. 修改[com.ctrip.framework.apollo.core.enums.Env](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/Env.java)类,在其中加入`BETA`枚举:
```java
public enum Env{
LOCAL, DEV, BETA, FWS, FAT, UAT, LPT, PRO, TOOLS, UNKNOWN;
...
}
```
3. 修改[com.ctrip.framework.apollo.core.enums.EnvUtils](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/enums/EnvUtils.java)类,在其中加入`BETA`枚举的转换逻辑:
```java
public final class EnvUtils {
public static Env transformEnv(String envName) {
if (StringUtils.isBlank(envName)) {
return Env.UNKNOWN;
}
switch (envName.trim().toUpperCase()) {
...
case "BETA":
return Env.BETA;
...
default:
return Env.UNKNOWN;
}
}
}
```
4. 修改[apollo-env.properties](https://github.com/ctripcorp/apollo/blob/master/apollo-portal/src/main/resources/apollo-env.properties),增加`beta.meta`占位符:
```properties
local.meta=http://localhost:8080
dev.meta=${dev_meta}
fat.meta=${fat_meta}
beta.meta=${beta_meta}
uat.meta=${uat_meta}
lpt.meta=${lpt_meta}
pro.meta=${pro_meta}
```
5. 修改[com.ctrip.framework.apollo.core.internals.LegacyMetaServerProvider](https://github.com/ctripcorp/apollo/blob/master/apollo-core/src/main/java/com/ctrip/framework/apollo/core/internals/LegacyMetaServerProvider.java)类,增加读取`BETA`环境的meta server地址逻辑:
```java
public class LegacyMetaServerProvider {
...
domains.put(Env.BETA, getMetaServerAddress(prop, "beta_meta", "beta.meta"));
...
}
```
6. protaldb增加`BETA`环境,参考[分布式部署指南 2.1.3.1一节](zh/deployment/distributed-deployment-guide?id=_2131-调整apolloportaldb配置)
7. 为apollo-portal添加新增环境对应的meta server地址,具体参考:[2.2.1.1.2.4 配置apollo-portal的meta service信息](zh/deployment/distributed-deployment-guide?id=_221124-配置apollo-portal的meta-service信息)。apollo-client在新的环境下使用时也需要做好相应的配置,具体参考:[1.2.2 Apollo Meta Server](zh/usage/java-sdk-user-guide?id=_122-apollo-meta-server)。
>注1:一套Portal可以管理多个环境,但是每个环境都需要独立部署一套Config Service、Admin Service和ApolloConfigDB,具体请参考:[2.1.2 创建ApolloConfigDB](zh/deployment/distributed-deployment-guide?id=_212-创建apolloconfigdb),[2.1.3.2 调整ApolloConfigDB配置](zh/deployment/distributed-deployment-guide?id=_2132-调整apolloconfigdb配置),[2.2.1.1.2 配置数据库连接信息](zh/deployment/distributed-deployment-guide?id=_22112-配置数据库连接信息)
> 注2:如果是为已经运行了一段时间的Apollo配置中心增加环境,别忘了参考[2.1.2.4 从别的环境导入ApolloConfigDB的项目数据](zh/deployment/distributed-deployment-guide?id=_2124-从别的环境导入apolloconfigdb的项目数据)对新的环境做初始化
### 5. 如何删除应用、集群、Namespace?
0.11.0版本开始Apollo管理员增加了删除应用、集群和AppNamespace的页面,建议使用该页面进行删除。
页面入口:
![delete-app-cluster-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/delete-app-cluster-namespace-entry.png)
页面详情:
![delete-app-cluster-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/delete-app-cluster-namespace-detail.png)
### 6. 客户端多块网卡造成获取IP不准,如何解决?
获取客户端网卡逻辑在1.4.0版本有所调整,所以需要根据客户端版本区分
#### 6.1 apollo-client为1.3.0及之前的版本
如果有多网卡,且都是普通网卡的话,需要在/etc/hosts里面加一条映射关系来提升权重。
格式:`ip ${hostname}`
这里的${hostname}就是你在机器上执行hostname的结果。
比如正确IP为:192.168.1.50,hostname执行结果为:jim-ubuntu-pc
那么最终在hosts文件映射的记录为:
```
192.168.1.50 jim-ubuntu-pc
```
#### 6.2 apollo-client为1.4.0及之后的版本
如果有多网卡,且都是普通网卡的话,可以通过调整它们在系统中的顺序来改变优先级,顺序在前的优先级更高。
### 7. 通过Apollo动态调整Spring Boot的Logging level
可以参考[apollo-use-cases](https://github.com/ctripcorp/apollo-use-cases)项目中的[spring-cloud-logger](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-cloud-logger)和[spring-boot-logger](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-boot-logger)代码示例。
### 8. 将Config Service和Admin Service注册到单独的Eureka Server上
Apollo默认自带了Eureka作为内部的注册中心实现,一般情况下不需要考虑为Apollo单独部署注册中心。
不过有些公司自己已经有了一套Eureka,如果希望把Apollo的Config Service和Admin Service也注册过去实现统一管理的话,可以按照如下步骤操作:
#### 1. 配置Config Service不启动内置Eureka Server
##### 1.1 1.5.0及以上版本
为apollo-configservice配置`apollo.eureka.server.enabled=false`即可,通过bootstrap.yml或-D参数等方式皆可。
##### 1.2 1.5.0之前的版本
修改[com.ctrip.framework.apollo.configservice.ConfigServiceApplication](https://github.com/ctripcorp/apollo/blob/master/apollo-configservice/src/main/java/com/ctrip/framework/apollo/configservice/ConfigServiceApplication.java),把`@EnableEurekaServer`改为`@EnableEurekaClient`
```java
@EnableEurekaClient
@EnableAspectJAutoProxy
@EnableAutoConfiguration // (exclude = EurekaClientConfigBean.class)
@Configuration
@EnableTransactionManagement
@PropertySource(value = {"classpath:configservice.properties"})
@ComponentScan(basePackageClasses = {ApolloCommonConfig.class,
ApolloBizConfig.class,
ConfigServiceApplication.class,
ApolloMetaServiceConfig.class})
public class ConfigServiceApplication {
...
}
```
#### 2. 修改ApolloConfigDB.ServerConfig表中的`eureka.service.url`,指向自己的Eureka地址
比如自己的Eureka服务地址是1.1.1.1:8761和2.2.2.2:8761,那么就将ApolloConfigDB.ServerConfig表中设置eureka.service.url为:
```
http://1.1.1.1:8761/eureka/,http://2.2.2.2:8761/eureka/
```
需要注意的是更改Eureka地址只需要改ApolloConfigDB.ServerConfig表中的`eureka.service.url`即可,不需要修改meta server地址。
> 默认情况下,meta service和config service是部署在同一个JVM进程,所以meta service的地址就是config service的地址,修改Eureka地址时不需要修改meta server地址。
### 9. Spring Boot中使用`ConditionalOnProperty`读取不到配置
`@ConditionalOnProperty`功能从0.10.0版本开始支持,具体可以参考 [Spring Boot集成方式](zh/usage/java-sdk-user-guide?id=_3213-spring-boot集成方式(推荐))
### 10. 多机房如何实现A机房的客户端就近读取A机房的config service,B机房的客户端就近读取B机房的config service?
请参考[Issue 1294](https://github.com/ctripcorp/apollo/issues/1294),该案例中由于中美机房相距甚远,所以需要config db两地部署,如果是同城多机房的话,两个机房的config service可以连同一个config db。
### 11. apollo是否有支持HEAD请求的页面?阿里云slb配置健康检查只支持HEAD请求
apollo的每个服务都有`/health`页面的,该页面是apollo用来做健康检测的,支持各种请求方法,如GET, POST, HEAD等。
### 12. apollo如何配置查看权限?
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
### 13. apollo如何放在独立的tomcat中跑?
有些公司的运维策略可能会要求必须使用独立的tomcat跑应用,不允许apollo默认的startup.sh方式运行,下面以apollo-configservice为例简述一下如何使apollo服务端运行在独立的tomcat中:
1. 获取apollo代码(生产部署建议用release的版本)
2. 修改apollo-configservice的pom.xml,增加`<packaging>war</packaging>`
3. 按照分布式部署文档配置build.sh,然后打包
4. 把apollo-configservice的war包放到tomcat下
* cp apollo-configservice/target/apollo-configservice-xxx.war ${tomcat-dir}/webapps/ROOT.war
运行tomcat的startup.sh
5. 运行tomcat的startup.sh
另外,apollo还有一些调优参数建议在tomcat的server.xml中配置一下,可以参考[application.properties](https://github.com/ctripcorp/apollo/blob/master/apollo-common/src/main/resources/application.properties#L12)
### 14. 注册中心Eureka如何替换为zookeeper?
许多公司微服务项目已经在使用zookeeper,如果出于方便服务管理的目的,希望Eureka替换为zookeeper的情况,可以参考[@hanyidreamer](https://github.com/hanyidreamer)贡献的改造步骤:[注册中心Eureka替换为zookeeper](https://blog.csdn.net/u014732209/article/details/89555535)
### 15. 本地多人同时开发,如何实现配置不一样且互不影响?
参考[#1560](https://github.com/ctripcorp/apollo/issues/1560)
### 16. Portal挂载到nginx/slb后如何设置相对路径?
一般情况下建议直接使用根目录来挂载portal,不过如果有些情况希望和其它应用共用nginx/slb,需要加上相对路径(如/apollo),那么可以按照下面的方式配置。
#### 16.1 Portal为1.7.0及以上版本
首先为apollo-portal增加-D参数`server.servlet.context-path=/apollo`或系统环境变量`SERVER_SERVLET_CONTEXT_PATH=/apollo`。
然后在nginx/slb上配置转发即可,以nginx为例:
```
location /apollo/ {
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://127.0.0.1:8070/apollo/;
}
```
#### 16.2 Portal为1.6.0及以上版本
首先为portal加上`prefix.path=/apollo`配置参数,配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`prefix.path`配置项即可。
然后在nginx/slb上配置转发即可,以nginx为例:
```
location /apollo/ {
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Server $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://127.0.0.1:8070/;
}
``` | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/deployment/quick-start-docker.md | 如果您对Docker非常熟悉,可以使用Docker的方式快速部署Apollo,从而快速的了解Apollo。如果您对Docker并不是很了解,请参考[常规方式部署Quick Start](zh/deployment/quick-start)。
另外需要说明的是,不管是Docker方式部署Quick Start还是常规方式部署的,Quick Start只是用来快速入门、了解Apollo。如果部署Apollo在公司中使用,请参考[分布式部署指南](zh/deployment/distributed-deployment-guide)。
> 由于Docker对windows的支持并不是很好,所以不建议您在windows环境下使用Docker方式部署,除非您对windows docker非常了解
## 一、 准备工作
### 1.1 安装Docker
具体步骤可以参考[Docker安装指南](https://yeasy.gitbooks.io/docker_practice/content/install/),通过以下命令测试是否成功安装
```
docker -v
```
为了加速Docker镜像下载,建议[配置镜像加速器](https://yeasy.gitbooks.io/docker_practice/content/install/mirror.html)。
### 1.2 下载Docker Quick Start配置文件
确保[docker-quick-start](https://github.com/ctripcorp/apollo/tree/master/scripts/docker-quick-start)文件夹已经在本地存在,如果本地已经clone过Apollo的代码,则可以跳过此步骤。
## 二、启动Apollo配置中心
在docker-quick-start目录下执行`docker-compose up`,第一次执行会触发下载镜像等操作,需要耐心等待一些时间。
搜索所有`apollo-quick-start`开头的日志,看到以下日志说明启动成功:
```log
apollo-quick-start | ==== starting service ====
apollo-quick-start | Service logging file is ./service/apollo-service.log
apollo-quick-start | Started [45]
apollo-quick-start | Waiting for config service startup.......
apollo-quick-start | Config service started. You may visit http://localhost:8080 for service status now!
apollo-quick-start | Waiting for admin service startup......
apollo-quick-start | Admin service started
apollo-quick-start | ==== starting portal ====
apollo-quick-start | Portal logging file is ./portal/apollo-portal.log
apollo-quick-start | Started [254]
apollo-quick-start | Waiting for portal startup.......
apollo-quick-start | Portal started. You can visit http://localhost:8070 now!
```
> 注1:数据库的端口映射为13306,所以如果希望在宿主机上访问数据库,可以通过localhost:13306,用户名是root,密码留空。
> 注2:如要查看更多服务的日志,可以通过`docker exec -it apollo-quick-start bash`登录, 然后到`/apollo-quick-start/service`和`/apollo-quick-start/portal`下查看日志信息。
## 三、使用Apollo配置中心
使用相关步骤可以参考[Quick Start - 四、使用Apollo配置中心](zh/deployment/quick-start#四、使用apollo配置中心)
需要注意的是,在Docker环境下需要通过下面的命令运行Demo客户端:
```bash
docker exec -i apollo-quick-start /apollo-quick-start/demo.sh client
```
| 如果您对Docker非常熟悉,可以使用Docker的方式快速部署Apollo,从而快速的了解Apollo。如果您对Docker并不是很了解,请参考[常规方式部署Quick Start](zh/deployment/quick-start)。
另外需要说明的是,不管是Docker方式部署Quick Start还是常规方式部署的,Quick Start只是用来快速入门、了解Apollo。如果部署Apollo在公司中使用,请参考[分布式部署指南](zh/deployment/distributed-deployment-guide)。
> 由于Docker对windows的支持并不是很好,所以不建议您在windows环境下使用Docker方式部署,除非您对windows docker非常了解
## 一、 准备工作
### 1.1 安装Docker
具体步骤可以参考[Docker安装指南](https://yeasy.gitbooks.io/docker_practice/content/install/),通过以下命令测试是否成功安装
```
docker -v
```
为了加速Docker镜像下载,建议[配置镜像加速器](https://yeasy.gitbooks.io/docker_practice/content/install/mirror.html)。
### 1.2 下载Docker Quick Start配置文件
确保[docker-quick-start](https://github.com/ctripcorp/apollo/tree/master/scripts/docker-quick-start)文件夹已经在本地存在,如果本地已经clone过Apollo的代码,则可以跳过此步骤。
## 二、启动Apollo配置中心
在docker-quick-start目录下执行`docker-compose up`,第一次执行会触发下载镜像等操作,需要耐心等待一些时间。
搜索所有`apollo-quick-start`开头的日志,看到以下日志说明启动成功:
```log
apollo-quick-start | ==== starting service ====
apollo-quick-start | Service logging file is ./service/apollo-service.log
apollo-quick-start | Started [45]
apollo-quick-start | Waiting for config service startup.......
apollo-quick-start | Config service started. You may visit http://localhost:8080 for service status now!
apollo-quick-start | Waiting for admin service startup......
apollo-quick-start | Admin service started
apollo-quick-start | ==== starting portal ====
apollo-quick-start | Portal logging file is ./portal/apollo-portal.log
apollo-quick-start | Started [254]
apollo-quick-start | Waiting for portal startup.......
apollo-quick-start | Portal started. You can visit http://localhost:8070 now!
```
> 注1:数据库的端口映射为13306,所以如果希望在宿主机上访问数据库,可以通过localhost:13306,用户名是root,密码留空。
> 注2:如要查看更多服务的日志,可以通过`docker exec -it apollo-quick-start bash`登录, 然后到`/apollo-quick-start/service`和`/apollo-quick-start/portal`下查看日志信息。
## 三、使用Apollo配置中心
使用相关步骤可以参考[Quick Start - 四、使用Apollo配置中心](zh/deployment/quick-start#四、使用apollo配置中心)
需要注意的是,在Docker环境下需要通过下面的命令运行Demo客户端:
```bash
docker exec -i apollo-quick-start /apollo-quick-start/demo.sh client
```
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./.github/ISSUE_TEMPLATE/bug_report_zh.md | ---
name: 报告Bug/使用疑问
about: 提交Apollo Bug/使用疑问,使用这个模板
title: ''
labels: ''
assignees: ''
---
<!-- 这段文字不会显示在你的内容中。为了避免重复的信息,方便后续的检索,在提issue之前,请检查如下事项。如果是比较新手级别的问题,推荐到讨论区https://github.com/ctripcorp/apollo/discussions 提问 -->
- [ ] 我已经检查过[discussions](https://github.com/ctripcorp/apollo/discussions)
- [ ] 我已经搜索过[issues](https://github.com/ctripcorp/apollo/issues)
- [ ] 我已经仔细检查过[FAQ](https://github.com/ctripcorp/apollo/wiki/%E9%83%A8%E7%BD%B2&%E5%BC%80%E5%8F%91%E9%81%87%E5%88%B0%E7%9A%84%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
**描述bug**
简洁明了地描述一下bug
**复现**
通过如下步骤可以复现:
1.
2.
3.
4.
**期望**
简介明了地描述你希望正常情况下应该发生什么
**截图**
如果可以,附上截图来描述你的问题
### 额外的细节和日志
- 版本:
- 错误日志
- 配置:
- 平台和操作系统 | ---
name: 报告Bug/使用疑问
about: 提交Apollo Bug/使用疑问,使用这个模板
title: ''
labels: ''
assignees: ''
---
<!-- 这段文字不会显示在你的内容中。为了避免重复的信息,方便后续的检索,在提issue之前,请检查如下事项。如果是比较新手级别的问题,推荐到讨论区https://github.com/ctripcorp/apollo/discussions 提问 -->
- [ ] 我已经检查过[discussions](https://github.com/ctripcorp/apollo/discussions)
- [ ] 我已经搜索过[issues](https://github.com/ctripcorp/apollo/issues)
- [ ] 我已经仔细检查过[FAQ](https://github.com/ctripcorp/apollo/wiki/%E9%83%A8%E7%BD%B2&%E5%BC%80%E5%8F%91%E9%81%87%E5%88%B0%E7%9A%84%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
**描述bug**
简洁明了地描述一下bug
**复现**
通过如下步骤可以复现:
1.
2.
3.
4.
**期望**
简介明了地描述你希望正常情况下应该发生什么
**截图**
如果可以,附上截图来描述你的问题
### 额外的细节和日志
- 版本:
- 错误日志
- 配置:
- 平台和操作系统 | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/usage/apollo-user-guide.md | #
# 名词解释
* 普通应用
* 普通应用指的是独立运行的程序,如
* Web应用程序
* 带有main函数的程序
* 公共组件
* 公共组件指的是发布的类库、客户端程序,不会自己独立运行,如
* Java的jar包
* .Net的dll文件
# 一、普通应用接入指南
## 1.1 创建项目
要使用Apollo,第一步需要创建项目。
1. 打开apollo-portal主页
2. 点击“创建项目”
![create-app-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-app-entry.png)
3. 输入项目信息
* 部门:选择应用所在的部门
* 应用AppId:用来标识应用身份的唯一id,格式为string,需要和客户端app.properties中配置的app.id对应
* 应用名称:应用名,仅用于界面展示
* 应用负责人:选择的人默认会成为该项目的管理员,具备项目权限管理、集群创建、Namespace创建等权限
![create-app](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-app.png)
4. 点击提交
创建成功后,会自动跳转到项目首页
![app-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-created.png)
## 1.2 项目权限分配
### 1.2.1 项目管理员权限
项目管理员拥有以下权限:
1. 可以管理项目的权限分配
2. 可以创建集群
3. 可以创建Namespace
创建项目时填写的应用负责人默认会成为项目的管理员之一,如果还需要其他人也成为项目管理员,可以按照下面步骤操作:
1. 点击页面左侧的“管理项目”
* ![app-permission-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-entry.png)
2. 搜索需要添加的成员并点击添加
* ![app-permission-search-user](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-search-user.png)
* ![app-permission-user-added](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-user-added.png)
### 1.2.2 配置编辑、发布权限
配置权限分为编辑和发布:
* 编辑权限允许用户在Apollo界面上创建、修改、删除配置
* 配置修改后只在Apollo界面上变化,不会影响到应用实际使用的配置
* 发布权限允许用户在Apollo界面上发布、回滚配置
* 配置只有在发布、回滚动作后才会被应用实际使用到
* Apollo在用户操作发布、回滚动作后实时通知到应用,并使最新配置生效
项目创建完,默认没有分配配置的编辑和发布权限,需要项目管理员进行授权。
1. 点击application这个namespace的授权按钮
* ![namespace-permission-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-entry.png)
2. 分配修改权限
* ![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
3. 分配发布权限
* ![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
## 1.3 添加配置项
编辑配置需要拥有这个Namespace的编辑权限,如果发现没有新增配置按钮,可以找项目管理员授权。
### 1.3.1 通过表格模式添加配置
1. 点击新增配置
* ![create-item-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-item-entry.png)
2. 输入配置项
* ![create-item-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-item-detail.png)
3. 点击提交
* ![item-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/item-created.png)
### 1.3.2 通过文本模式编辑
Apollo除了支持表格模式,逐个添加、修改配置外,还提供文本模式批量添加、修改。
这个对于从已有的properties文件迁移尤其有用。
1. 切换到文本编辑模式
![text-mode-config-overview](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-overview.png)
2. 点击右侧的修改配置按钮
![text-mode-config-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-entry.png)
3. 输入配置项,并点击提交修改
![text-mode-config-submit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-submit.png)
## 1.4 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![publish-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/hermes-portal-publish-entry.png)
2. 填写发布相关信息,点击发布
![publish-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/hermes-portal-publish-detail.png)
## 1.5 应用读取配置
配置发布成功后,应用就可以通过Apollo客户端读取到配置了。
Apollo目前提供Java客户端,具体信息请点击[Java客户端使用文档](zh/usage/java-sdk-user-guide):
如果应用使用了其它语言,也可以通过直接访问Http接口获取配置,具体可以参考[其它语言客户端接入指南](zh/usage/other-language-client-user-guide)
## 1.6 回滚已发布配置
如果发现已发布的配置有问题,可以通过点击『回滚』按钮来将客户端读取到的配置回滚到上一个发布版本。
这里的回滚机制类似于发布系统,发布系统中的回滚操作是将部署到机器上的安装包回滚到上一个部署的版本,但代码仓库中的代码是不会回滚的,从而开发可以在修复代码后重新发布。
Apollo中的回滚也是类似的机制,点击回滚后是将发布到客户端的配置回滚到上一个已发布版本,也就是说客户端读取到的配置会恢复到上一个版本,但页面上编辑状态的配置是不会回滚的,从而开发可以在修复配置后重新发布。
# 二、公共组件接入指南
## 2.1 公共组件和普通应用的区别
公共组件是指那些发布给其它应用使用的客户端代码,比如CAT客户端、Hermes Producer客户端等。
虽然这类组件是由其他团队开发、维护,但是运行时是在业务实际应用内的,所以本质上可以认为是应用的一部分。
通常情况下,这类组件所用到的配置由原始开发团队维护,不过由于实际应用的运行时、环境各不一样,所以我们也允许应用在实际使用时能够覆盖公共组件的部分配置。
## 2.2 公共组件接入步骤
公共组件的接入步骤,和普通应用几乎一致,唯一的区别是公共组件需要创建自己唯一的Namespace。
所以,首先执行普通应用接入文档中的以下几个步骤,然后再按照本章节后面的步骤操作。
1. [创建项目](#_11-%E5%88%9B%E5%BB%BA%E9%A1%B9%E7%9B%AE)
2. [项目管理员权限](#_121-%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86%E5%91%98%E6%9D%83%E9%99%90)
### 2.2.1 创建Namespace
创建Namespace需要项目管理员权限,如果发现没有添加Namespace按钮,可以找项目管理员授权。
1. 点击页面左侧的添加Namespace
* ![create-namespace](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace.png)
2. 点击“创建新的Namespace”
* ![create-namespace-select-type](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace-select-type.png)
3. 输入公共组件的Namespace名称,需要注意的是Namespace名称全局唯一
* Apollo会默认把部门代号添加在最前面
* ![create-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace-detail.png)
4. 点击提交后,页面会自动跳转到关联Namespace页面
* 首先,选中所有需要有这个Namespace的环境和集群,一般建议全选
* 其次,选中刚刚创建的namespace
* 最后,点击提交
* ![link-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-namespace-detail.png)
5. 关联成功后,页面会自动跳转到Namespace权限管理页面
1. 分配修改权限
* ![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
2. 分配发布权限
* ![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
6. 点击“返回”回到项目页面
### 2.2.2 添加配置项
编辑配置需要拥有这个Namespace的编辑权限,如果发现没有新增配置按钮,可以找项目管理员授权。
#### 2.2.2.1 通过表格模式添加配置
1. 点击新增配置
![public-namespace-edit-item-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-edit-item-entry.png)
2. 输入配置项
![public-namespace-edit-item](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-edit-item.png)
3. 点击提交
![public-namespace-item-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-item-created.png)
#### 2.2.2.2 通过文本模式编辑
这部分和普通应用一致,具体步骤请参见[1.3.2 通过文本模式编辑](#_132-%E9%80%9A%E8%BF%87%E6%96%87%E6%9C%AC%E6%A8%A1%E5%BC%8F%E7%BC%96%E8%BE%91)。
### 2.2.3 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![public-namespace-publish-items-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-publish-items-entry.png)
2. 填写发布相关信息,点击发布
![public-namespace-publish-items](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-publish-items.png)
### 2.2.4 应用读取配置
配置发布成功后,应用就可以通过Apollo客户端读取到配置了。
Apollo目前提供Java客户端,具体信息请点击[Java客户端使用文档](zh/usage/java-sdk-user-guide):
如果应用使用了其它语言,也可以通过直接访问Http接口获取配置,具体可以参考[其它语言客户端接入指南](zh/usage/other-language-client-user-guide)
对于公共组件的配置读取,可以参考上述文档中的“获取公共Namespace的配置”部分。
## 2.3 应用覆盖公用组件配置步骤
前面提到,通常情况下,公共组件所用到的配置由原始开发团队维护,不过由于实际应用的运行时、环境各不一样,所以我们也允许应用在实际使用时能够覆盖公共组件的部分配置。
这里就讲一下应用如何覆盖公用组件的配置,简单起见,假设apollo-portal应用使用了hermes producer客户端,并且希望调整hermes的批量发送大小。
### 2.3.1 关联公共组件Namespace
1. 进入使用公共组件的应用项目首页,点击左侧的添加Namespace按钮
* 所以,在这个例子中,我们需要进入apollo-portal的首页。
* (添加Namespace需要项目管理员权限,如果发现没有添加Namespace按钮,可以找项目管理员授权)
* ![link-public-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-public-namespace-entry.png)
2. 找到hermes producer的namespace,并选择需要关联到哪些环境和集群
![link-public-namespace](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-public-namespace.png)
3. 关联成功后,页面会自动跳转到Namespace权限管理页面
1. 分配修改权限
![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
2. 分配发布权限
![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
4. 点击“返回”回到项目页面
### 2.3.2 覆盖公用组件配置
1. 点击新增配置
![override-public-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-entry.png)
2. 输入要覆盖的配置项
![override-public-namespace-item](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item.png)
3. 点击提交
![override-public-namespace-item-done](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-done.png)
### 2.3.3 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![override-public-namespace-item-publish-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-publish-entry.png)
2. 填写发布相关信息,点击发布
![override-public-namespace-item-publish](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-publish.png)
3. 配置发布成功后,hermes producer客户端在apollo-portal应用里面运行时读取到的sender.batchSize的值就是1000。
# 三、集群独立配置说明
在有些特殊情况下,应用有需求对不同的集群做不同的配置,比如部署在A机房的应用连接的es服务器地址和部署在B机房的应用连接的es服务器地址不一样。
在这种情况下,可以通过在Apollo创建不同的集群来解决。
## 3.1 创建集群
创建集群需要项目管理员权限,如果发现没有添加集群按钮,可以找项目管理员授权。
1. 点击页面左侧的“添加集群”按钮
* ![create-cluster](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-cluster.png)
2. 输入集群名称,选择环境并提交
* ![create-cluster-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-cluster-detail.png)
3. 切换到对应的集群,修改配置并发布即可
* ![config-in-cluster-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/cluster-created.png)
4. 通过上述配置,部署在SHAJQ机房的应用就会读到SHAJQ集群下的配置
5. 如果应用还在其它机房部署了应用,那么在上述的配置下,会读到default集群下的配置。
# 四、多个AppId使用同一份配置
在一些情况下,尽管应用本身不是公共组件,但还是需要在多个AppId之间共用同一份配置,比如同一个产品的不同项目:XX-Web, XX-Service, XX-Job等。
这种情况下如果希望实现多个AppId使用同一份配置的话,基本概念和公共组件的配置是一致的。
具体来说,就是在其中一个AppId下创建一个namespace,写入公共的配置信息,然后在各个项目中读取该namespace的配置即可。
如果某个AppId需要覆盖公共的配置信息,那么在该AppId下关联公共的namespace并写入需要覆盖的配置即可。
具体步骤可以参考[公共组件接入指南](#%e4%ba%8c%e3%80%81%e5%85%ac%e5%85%b1%e7%bb%84%e4%bb%b6%e6%8e%a5%e5%85%a5%e6%8c%87%e5%8d%97)。
# 五、灰度发布使用指南
通过灰度发布功能,可以实现:
1. 对于一些对程序有比较大影响的配置,可以先在一个或者多个实例生效,观察一段时间没问题后再全量发布配置。
2. 对于一些需要调优的配置参数,可以通过灰度发布功能来实现A/B测试。可以在不同的机器上应用不同的配置,不断调整、测评一段时间后找出较优的配置再全量发布配置。
下面将结合一个实际例子来描述如何使用灰度发布功能。
## 5.1 场景介绍
100004458(apollo-demo)项目有两个客户端:
1. 10.32.21.19
2. 10.32.21.22
![initial-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-instance-list.png)
**灰度目标:**
* 当前有一个配置timeout=2000,我们希望对10.32.21.22灰度发布timeout=3000,对10.32.21.19仍然是timeout=2000。
![initial-config](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-config.png)
## 5.2 创建灰度
首先点击application namespace右上角的`创建灰度`按钮。
![create-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/create-gray-release.png)
点击确定后,灰度版本就创建成功了,页面会自动切换到`灰度版本`Tab。
![initial-gray-release-tab](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-gray-release-tab.png)
## 5.3 灰度配置
点击`主版本的配置`中,timeout配置最右侧的`对此配置灰度`按钮
![initial-gray-release-tab](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/edit-gray-release-config.png)
在弹出框中填入要灰度的值:3000,点击提交。
![submit-gray-release-config](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/submit-gray-release-config.png)
![gray-release-config-submitted](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-config-submitted.png)
## 5.4 配置灰度规则
切换到`灰度规则`Tab,点击`新增规则`按钮
![new-gray-release-rule](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/new-gray-release-rule.png)
在弹出框中`灰度的IP`下拉框会默认展示当前使用配置的机器列表,选择我们要灰度的IP,点击完成。
![select-gray-release-ip](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/select-gray-release-ip.png)
![gray-release-ip-selected](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-ip-selected.png)
![gray-release-rule-saved](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-rule-saved.png)
如果下拉框中没找到需要的IP,说明机器还没从Apollo取过配置,可以点击手动输入IP来输入,输入完后点击添加按钮
![manual-input-gray-release-ip](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/manual-input-gray-release-ip.png)
![manual-input-gray-release-ip-2](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/manual-input-gray-release-ip-2.png)
>注:对于公共Namespace的灰度规则,需要先指定要灰度的appId,然后再选择IP。
## 5.5 灰度发布
配置规则已经生效,不过灰度配置还没有发布。切换到`配置`Tab。
再次检查灰度的配置部分,如果没有问题,点击`灰度发布`。
![prepare-to-do-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/prepare-to-do-gray-release.png)
在弹出框中可以看到主版本的值是2000,灰度版本即将发布的值是3000。填入其它信息后,点击发布。
![gray-release-confirm-dialog](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-confirm-dialog.png)
发布后,切换到`灰度实例列表`Tab,就能看到10.32.21.22已经使用了灰度发布的值。
![gray-release-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-instance-list.png)
切换到`主版本`的`实例列表`,会看到主版本配置只有10.32.21.19在使用了。
![master-branch-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/master-branch-instance-list.png)
后面可以继续配置的修改或规则的更改。配置的修改需要点击灰度发布后才会生效,规则的修改在规则点击完成后就会实时生效。
## 5.6 全量发布
如果灰度的配置测试下来比较理想,符合预期,那么就可以操作`全量发布`。
全量发布的效果是:
1. 灰度版本的配置会合并回主版本,在这个例子中,就是主版本的timeout会被更新成3000
2. 主版本的配置会自动进行一次发布
3. 在全量发布页面,可以选择是否保留当前灰度版本,默认为不保留。
![prepare-to-full-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/prepare-to-full-release.png)
![full-release-confirm-dialog](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/full-release-confirm-dialog.png)
![full-release-confirm-dialog-2](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/full-release-confirm-dialog-2.png)
我选择了不保留灰度版本,所以发布完的效果就是主版本的配置更新、灰度版本删除。点击主版本的实例列表,可以看到10.32.21.22和10.32.21.19都使用了主版本最新的配置。
![master-branch-instance-list-after-full-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/master-branch-instance-list-after-full-release.png)
## 5.7 放弃灰度
如果灰度版本不理想或者不需要了,可以点击`放弃灰度`。
![abandon-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/abandon-gray-release.png)
## 5.8 发布历史
点击主版本的`发布历史`按钮,可以看到当前namespace的主版本以及灰度版本的发布历史。
![view-release-history](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/view-release-history.png)
![view-release-history-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/view-release-history-detail.png)
# 六、其它功能配置
## 6.1 配置查看权限
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
## 6.2 配置访问密钥
Apollo从1.6.0版本开始增加访问密钥机制,从而只有经过身份验证的客户端才能访问敏感配置。如果应用开启了访问密钥,客户端需要配置密钥,否则无法获取配置。
1. 项目管理员打开管理密钥页面
![管理密钥入口](https://user-images.githubusercontent.com/837658/94990081-f4d3cd80-05ab-11eb-9470-fed5ec6de92e.png)
2. 为项目的每个环境生成访问密钥,注意默认是禁用的,建议在客户端都配置完成后再开启
![密钥配置页面](https://user-images.githubusercontent.com/837658/94990150-788dba00-05ac-11eb-9a12-727fdb872e42.png)
3. 客户端侧[配置访问密钥](zh/usage/java-sdk-user-guide#_1244-配置访问密钥)
# 七、最佳实践
## 7.1 安全相关
配置中心作为基础服务,存储着公司非常重要的配置信息,所以安全因素需要大家重点关注,下面列举了一些注意事项供大家参考,也欢迎大家分享自己的实践案例。
### 7.1.1 认证
建议接入公司统一的身份认证系统,如 SSO、LDAP 等,接入方式可以参考[Portal 实现用户登录功能](zh/development/portal-how-to-implement-user-login-function)
> 如果使用Apollo提供的Spring Security简单认证,务必记得要修改超级管理员apollo的密码
### 7.1.2 授权
Apollo 支持细粒度的权限控制,请务必根据实际情况做好权限控制:
1. [项目管理员权限](#_121-项目管理员权限)
* Apollo 默认允许所有登录用户创建项目,如果只允许部分用户创建项目,可以开启[创建项目权限控制](zh/deployment/distributed-deployment-guide?id=_10-rolecreate-applicationenabled-是否开启创建项目权限控制)
2. [配置编辑、发布权限](#_122-配置编辑、发布权限)
* 配置编辑、发布权限支持按环境配置,比如开发环境开发人员可以自行完成配置编辑和发布的过程,但是生产环境发布权限交由测试或运维人员
* 生产环境建议同时开启[发布审核](zh/deployment/distributed-deployment-guide?id=_2-namespacelockswitch-一次发布只能有一个人修改开关,用于发布审核),从而控制一次配置发布只能由一个人修改,另一个人发布,确保配置修改得到充分检查
3. [配置查看权限](#_61-配置查看权限)
* 可以指定某个环境只允许项目成员查看私有Namespace的配置,从而避免敏感配置泄露,如生产环境
### 7.1.3 系统访问
除了用户权限,在系统访问上也需要加以考虑:
1. `apollo-configservice`和`apollo-adminservice`是基于内网可信网络设计的,所以出于安全考虑,禁止`apollo-configservice`和`apollo-adminservice`直接暴露在公网
2. 对敏感配置可以考虑开启[访问秘钥](#_62-%e9%85%8d%e7%bd%ae%e8%ae%bf%e9%97%ae%e5%af%86%e9%92%a5),从而只有经过身份验证的客户端才能访问敏感配置
3. 1.7.1及以上版本可以考虑为`apollo-adminservice`开启[访问控制](zh/deployment/distributed-deployment-guide?id=_6-admin-serviceaccesscontrolenabled-配置apollo-adminservice是否开启访问控制),从而只有合法的`apollo-portal`才能访问对应接口,增强安全性 | #
# 名词解释
* 普通应用
* 普通应用指的是独立运行的程序,如
* Web应用程序
* 带有main函数的程序
* 公共组件
* 公共组件指的是发布的类库、客户端程序,不会自己独立运行,如
* Java的jar包
* .Net的dll文件
# 一、普通应用接入指南
## 1.1 创建项目
要使用Apollo,第一步需要创建项目。
1. 打开apollo-portal主页
2. 点击“创建项目”
![create-app-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-app-entry.png)
3. 输入项目信息
* 部门:选择应用所在的部门
* 应用AppId:用来标识应用身份的唯一id,格式为string,需要和客户端app.properties中配置的app.id对应
* 应用名称:应用名,仅用于界面展示
* 应用负责人:选择的人默认会成为该项目的管理员,具备项目权限管理、集群创建、Namespace创建等权限
![create-app](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-app.png)
4. 点击提交
创建成功后,会自动跳转到项目首页
![app-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-created.png)
## 1.2 项目权限分配
### 1.2.1 项目管理员权限
项目管理员拥有以下权限:
1. 可以管理项目的权限分配
2. 可以创建集群
3. 可以创建Namespace
创建项目时填写的应用负责人默认会成为项目的管理员之一,如果还需要其他人也成为项目管理员,可以按照下面步骤操作:
1. 点击页面左侧的“管理项目”
* ![app-permission-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-entry.png)
2. 搜索需要添加的成员并点击添加
* ![app-permission-search-user](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-search-user.png)
* ![app-permission-user-added](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/app-permission-user-added.png)
### 1.2.2 配置编辑、发布权限
配置权限分为编辑和发布:
* 编辑权限允许用户在Apollo界面上创建、修改、删除配置
* 配置修改后只在Apollo界面上变化,不会影响到应用实际使用的配置
* 发布权限允许用户在Apollo界面上发布、回滚配置
* 配置只有在发布、回滚动作后才会被应用实际使用到
* Apollo在用户操作发布、回滚动作后实时通知到应用,并使最新配置生效
项目创建完,默认没有分配配置的编辑和发布权限,需要项目管理员进行授权。
1. 点击application这个namespace的授权按钮
* ![namespace-permission-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-entry.png)
2. 分配修改权限
* ![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
3. 分配发布权限
* ![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
## 1.3 添加配置项
编辑配置需要拥有这个Namespace的编辑权限,如果发现没有新增配置按钮,可以找项目管理员授权。
### 1.3.1 通过表格模式添加配置
1. 点击新增配置
* ![create-item-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-item-entry.png)
2. 输入配置项
* ![create-item-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-item-detail.png)
3. 点击提交
* ![item-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/item-created.png)
### 1.3.2 通过文本模式编辑
Apollo除了支持表格模式,逐个添加、修改配置外,还提供文本模式批量添加、修改。
这个对于从已有的properties文件迁移尤其有用。
1. 切换到文本编辑模式
![text-mode-config-overview](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-overview.png)
2. 点击右侧的修改配置按钮
![text-mode-config-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-entry.png)
3. 输入配置项,并点击提交修改
![text-mode-config-submit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/text-mode-config-submit.png)
## 1.4 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![publish-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/hermes-portal-publish-entry.png)
2. 填写发布相关信息,点击发布
![publish-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/hermes-portal-publish-detail.png)
## 1.5 应用读取配置
配置发布成功后,应用就可以通过Apollo客户端读取到配置了。
Apollo目前提供Java客户端,具体信息请点击[Java客户端使用文档](zh/usage/java-sdk-user-guide):
如果应用使用了其它语言,也可以通过直接访问Http接口获取配置,具体可以参考[其它语言客户端接入指南](zh/usage/other-language-client-user-guide)
## 1.6 回滚已发布配置
如果发现已发布的配置有问题,可以通过点击『回滚』按钮来将客户端读取到的配置回滚到上一个发布版本。
这里的回滚机制类似于发布系统,发布系统中的回滚操作是将部署到机器上的安装包回滚到上一个部署的版本,但代码仓库中的代码是不会回滚的,从而开发可以在修复代码后重新发布。
Apollo中的回滚也是类似的机制,点击回滚后是将发布到客户端的配置回滚到上一个已发布版本,也就是说客户端读取到的配置会恢复到上一个版本,但页面上编辑状态的配置是不会回滚的,从而开发可以在修复配置后重新发布。
# 二、公共组件接入指南
## 2.1 公共组件和普通应用的区别
公共组件是指那些发布给其它应用使用的客户端代码,比如CAT客户端、Hermes Producer客户端等。
虽然这类组件是由其他团队开发、维护,但是运行时是在业务实际应用内的,所以本质上可以认为是应用的一部分。
通常情况下,这类组件所用到的配置由原始开发团队维护,不过由于实际应用的运行时、环境各不一样,所以我们也允许应用在实际使用时能够覆盖公共组件的部分配置。
## 2.2 公共组件接入步骤
公共组件的接入步骤,和普通应用几乎一致,唯一的区别是公共组件需要创建自己唯一的Namespace。
所以,首先执行普通应用接入文档中的以下几个步骤,然后再按照本章节后面的步骤操作。
1. [创建项目](#_11-%E5%88%9B%E5%BB%BA%E9%A1%B9%E7%9B%AE)
2. [项目管理员权限](#_121-%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86%E5%91%98%E6%9D%83%E9%99%90)
### 2.2.1 创建Namespace
创建Namespace需要项目管理员权限,如果发现没有添加Namespace按钮,可以找项目管理员授权。
1. 点击页面左侧的添加Namespace
* ![create-namespace](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace.png)
2. 点击“创建新的Namespace”
* ![create-namespace-select-type](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace-select-type.png)
3. 输入公共组件的Namespace名称,需要注意的是Namespace名称全局唯一
* Apollo会默认把部门代号添加在最前面
* ![create-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-namespace-detail.png)
4. 点击提交后,页面会自动跳转到关联Namespace页面
* 首先,选中所有需要有这个Namespace的环境和集群,一般建议全选
* 其次,选中刚刚创建的namespace
* 最后,点击提交
* ![link-namespace-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-namespace-detail.png)
5. 关联成功后,页面会自动跳转到Namespace权限管理页面
1. 分配修改权限
* ![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
2. 分配发布权限
* ![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
6. 点击“返回”回到项目页面
### 2.2.2 添加配置项
编辑配置需要拥有这个Namespace的编辑权限,如果发现没有新增配置按钮,可以找项目管理员授权。
#### 2.2.2.1 通过表格模式添加配置
1. 点击新增配置
![public-namespace-edit-item-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-edit-item-entry.png)
2. 输入配置项
![public-namespace-edit-item](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-edit-item.png)
3. 点击提交
![public-namespace-item-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-item-created.png)
#### 2.2.2.2 通过文本模式编辑
这部分和普通应用一致,具体步骤请参见[1.3.2 通过文本模式编辑](#_132-%E9%80%9A%E8%BF%87%E6%96%87%E6%9C%AC%E6%A8%A1%E5%BC%8F%E7%BC%96%E8%BE%91)。
### 2.2.3 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![public-namespace-publish-items-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-publish-items-entry.png)
2. 填写发布相关信息,点击发布
![public-namespace-publish-items](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/public-namespace-publish-items.png)
### 2.2.4 应用读取配置
配置发布成功后,应用就可以通过Apollo客户端读取到配置了。
Apollo目前提供Java客户端,具体信息请点击[Java客户端使用文档](zh/usage/java-sdk-user-guide):
如果应用使用了其它语言,也可以通过直接访问Http接口获取配置,具体可以参考[其它语言客户端接入指南](zh/usage/other-language-client-user-guide)
对于公共组件的配置读取,可以参考上述文档中的“获取公共Namespace的配置”部分。
## 2.3 应用覆盖公用组件配置步骤
前面提到,通常情况下,公共组件所用到的配置由原始开发团队维护,不过由于实际应用的运行时、环境各不一样,所以我们也允许应用在实际使用时能够覆盖公共组件的部分配置。
这里就讲一下应用如何覆盖公用组件的配置,简单起见,假设apollo-portal应用使用了hermes producer客户端,并且希望调整hermes的批量发送大小。
### 2.3.1 关联公共组件Namespace
1. 进入使用公共组件的应用项目首页,点击左侧的添加Namespace按钮
* 所以,在这个例子中,我们需要进入apollo-portal的首页。
* (添加Namespace需要项目管理员权限,如果发现没有添加Namespace按钮,可以找项目管理员授权)
* ![link-public-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-public-namespace-entry.png)
2. 找到hermes producer的namespace,并选择需要关联到哪些环境和集群
![link-public-namespace](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/link-public-namespace.png)
3. 关联成功后,页面会自动跳转到Namespace权限管理页面
1. 分配修改权限
![namespace-permission-edit](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-permission-edit.png)
2. 分配发布权限
![namespace-publish-permission](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/namespace-publish-permission.png)
4. 点击“返回”回到项目页面
### 2.3.2 覆盖公用组件配置
1. 点击新增配置
![override-public-namespace-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-entry.png)
2. 输入要覆盖的配置项
![override-public-namespace-item](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item.png)
3. 点击提交
![override-public-namespace-item-done](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-done.png)
### 2.3.3 发布配置
配置只有在发布后才会真的被应用使用到,所以在编辑完配置后,需要发布配置。
发布配置需要拥有这个Namespace的发布权限,如果发现没有发布按钮,可以找项目管理员授权。
1. 点击“发布按钮”
![override-public-namespace-item-publish-entry](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-publish-entry.png)
2. 填写发布相关信息,点击发布
![override-public-namespace-item-publish](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/override-public-namespace-item-publish.png)
3. 配置发布成功后,hermes producer客户端在apollo-portal应用里面运行时读取到的sender.batchSize的值就是1000。
# 三、集群独立配置说明
在有些特殊情况下,应用有需求对不同的集群做不同的配置,比如部署在A机房的应用连接的es服务器地址和部署在B机房的应用连接的es服务器地址不一样。
在这种情况下,可以通过在Apollo创建不同的集群来解决。
## 3.1 创建集群
创建集群需要项目管理员权限,如果发现没有添加集群按钮,可以找项目管理员授权。
1. 点击页面左侧的“添加集群”按钮
* ![create-cluster](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-cluster.png)
2. 输入集群名称,选择环境并提交
* ![create-cluster-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/create-cluster-detail.png)
3. 切换到对应的集群,修改配置并发布即可
* ![config-in-cluster-created](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/cluster-created.png)
4. 通过上述配置,部署在SHAJQ机房的应用就会读到SHAJQ集群下的配置
5. 如果应用还在其它机房部署了应用,那么在上述的配置下,会读到default集群下的配置。
# 四、多个AppId使用同一份配置
在一些情况下,尽管应用本身不是公共组件,但还是需要在多个AppId之间共用同一份配置,比如同一个产品的不同项目:XX-Web, XX-Service, XX-Job等。
这种情况下如果希望实现多个AppId使用同一份配置的话,基本概念和公共组件的配置是一致的。
具体来说,就是在其中一个AppId下创建一个namespace,写入公共的配置信息,然后在各个项目中读取该namespace的配置即可。
如果某个AppId需要覆盖公共的配置信息,那么在该AppId下关联公共的namespace并写入需要覆盖的配置即可。
具体步骤可以参考[公共组件接入指南](#%e4%ba%8c%e3%80%81%e5%85%ac%e5%85%b1%e7%bb%84%e4%bb%b6%e6%8e%a5%e5%85%a5%e6%8c%87%e5%8d%97)。
# 五、灰度发布使用指南
通过灰度发布功能,可以实现:
1. 对于一些对程序有比较大影响的配置,可以先在一个或者多个实例生效,观察一段时间没问题后再全量发布配置。
2. 对于一些需要调优的配置参数,可以通过灰度发布功能来实现A/B测试。可以在不同的机器上应用不同的配置,不断调整、测评一段时间后找出较优的配置再全量发布配置。
下面将结合一个实际例子来描述如何使用灰度发布功能。
## 5.1 场景介绍
100004458(apollo-demo)项目有两个客户端:
1. 10.32.21.19
2. 10.32.21.22
![initial-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-instance-list.png)
**灰度目标:**
* 当前有一个配置timeout=2000,我们希望对10.32.21.22灰度发布timeout=3000,对10.32.21.19仍然是timeout=2000。
![initial-config](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-config.png)
## 5.2 创建灰度
首先点击application namespace右上角的`创建灰度`按钮。
![create-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/create-gray-release.png)
点击确定后,灰度版本就创建成功了,页面会自动切换到`灰度版本`Tab。
![initial-gray-release-tab](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/initial-gray-release-tab.png)
## 5.3 灰度配置
点击`主版本的配置`中,timeout配置最右侧的`对此配置灰度`按钮
![initial-gray-release-tab](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/edit-gray-release-config.png)
在弹出框中填入要灰度的值:3000,点击提交。
![submit-gray-release-config](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/submit-gray-release-config.png)
![gray-release-config-submitted](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-config-submitted.png)
## 5.4 配置灰度规则
切换到`灰度规则`Tab,点击`新增规则`按钮
![new-gray-release-rule](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/new-gray-release-rule.png)
在弹出框中`灰度的IP`下拉框会默认展示当前使用配置的机器列表,选择我们要灰度的IP,点击完成。
![select-gray-release-ip](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/select-gray-release-ip.png)
![gray-release-ip-selected](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-ip-selected.png)
![gray-release-rule-saved](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-rule-saved.png)
如果下拉框中没找到需要的IP,说明机器还没从Apollo取过配置,可以点击手动输入IP来输入,输入完后点击添加按钮
![manual-input-gray-release-ip](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/manual-input-gray-release-ip.png)
![manual-input-gray-release-ip-2](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/manual-input-gray-release-ip-2.png)
>注:对于公共Namespace的灰度规则,需要先指定要灰度的appId,然后再选择IP。
## 5.5 灰度发布
配置规则已经生效,不过灰度配置还没有发布。切换到`配置`Tab。
再次检查灰度的配置部分,如果没有问题,点击`灰度发布`。
![prepare-to-do-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/prepare-to-do-gray-release.png)
在弹出框中可以看到主版本的值是2000,灰度版本即将发布的值是3000。填入其它信息后,点击发布。
![gray-release-confirm-dialog](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-confirm-dialog.png)
发布后,切换到`灰度实例列表`Tab,就能看到10.32.21.22已经使用了灰度发布的值。
![gray-release-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/gray-release-instance-list.png)
切换到`主版本`的`实例列表`,会看到主版本配置只有10.32.21.19在使用了。
![master-branch-instance-list](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/master-branch-instance-list.png)
后面可以继续配置的修改或规则的更改。配置的修改需要点击灰度发布后才会生效,规则的修改在规则点击完成后就会实时生效。
## 5.6 全量发布
如果灰度的配置测试下来比较理想,符合预期,那么就可以操作`全量发布`。
全量发布的效果是:
1. 灰度版本的配置会合并回主版本,在这个例子中,就是主版本的timeout会被更新成3000
2. 主版本的配置会自动进行一次发布
3. 在全量发布页面,可以选择是否保留当前灰度版本,默认为不保留。
![prepare-to-full-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/prepare-to-full-release.png)
![full-release-confirm-dialog](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/full-release-confirm-dialog.png)
![full-release-confirm-dialog-2](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/full-release-confirm-dialog-2.png)
我选择了不保留灰度版本,所以发布完的效果就是主版本的配置更新、灰度版本删除。点击主版本的实例列表,可以看到10.32.21.22和10.32.21.19都使用了主版本最新的配置。
![master-branch-instance-list-after-full-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/master-branch-instance-list-after-full-release.png)
## 5.7 放弃灰度
如果灰度版本不理想或者不需要了,可以点击`放弃灰度`。
![abandon-gray-release](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/abandon-gray-release.png)
## 5.8 发布历史
点击主版本的`发布历史`按钮,可以看到当前namespace的主版本以及灰度版本的发布历史。
![view-release-history](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/view-release-history.png)
![view-release-history-detail](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/gray-release/view-release-history-detail.png)
# 六、其它功能配置
## 6.1 配置查看权限
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
## 6.2 配置访问密钥
Apollo从1.6.0版本开始增加访问密钥机制,从而只有经过身份验证的客户端才能访问敏感配置。如果应用开启了访问密钥,客户端需要配置密钥,否则无法获取配置。
1. 项目管理员打开管理密钥页面
![管理密钥入口](https://user-images.githubusercontent.com/837658/94990081-f4d3cd80-05ab-11eb-9470-fed5ec6de92e.png)
2. 为项目的每个环境生成访问密钥,注意默认是禁用的,建议在客户端都配置完成后再开启
![密钥配置页面](https://user-images.githubusercontent.com/837658/94990150-788dba00-05ac-11eb-9a12-727fdb872e42.png)
3. 客户端侧[配置访问密钥](zh/usage/java-sdk-user-guide#_1244-配置访问密钥)
# 七、最佳实践
## 7.1 安全相关
配置中心作为基础服务,存储着公司非常重要的配置信息,所以安全因素需要大家重点关注,下面列举了一些注意事项供大家参考,也欢迎大家分享自己的实践案例。
### 7.1.1 认证
建议接入公司统一的身份认证系统,如 SSO、LDAP 等,接入方式可以参考[Portal 实现用户登录功能](zh/development/portal-how-to-implement-user-login-function)
> 如果使用Apollo提供的Spring Security简单认证,务必记得要修改超级管理员apollo的密码
### 7.1.2 授权
Apollo 支持细粒度的权限控制,请务必根据实际情况做好权限控制:
1. [项目管理员权限](#_121-项目管理员权限)
* Apollo 默认允许所有登录用户创建项目,如果只允许部分用户创建项目,可以开启[创建项目权限控制](zh/deployment/distributed-deployment-guide?id=_10-rolecreate-applicationenabled-是否开启创建项目权限控制)
2. [配置编辑、发布权限](#_122-配置编辑、发布权限)
* 配置编辑、发布权限支持按环境配置,比如开发环境开发人员可以自行完成配置编辑和发布的过程,但是生产环境发布权限交由测试或运维人员
* 生产环境建议同时开启[发布审核](zh/deployment/distributed-deployment-guide?id=_2-namespacelockswitch-一次发布只能有一个人修改开关,用于发布审核),从而控制一次配置发布只能由一个人修改,另一个人发布,确保配置修改得到充分检查
3. [配置查看权限](#_61-配置查看权限)
* 可以指定某个环境只允许项目成员查看私有Namespace的配置,从而避免敏感配置泄露,如生产环境
### 7.1.3 系统访问
除了用户权限,在系统访问上也需要加以考虑:
1. `apollo-configservice`和`apollo-adminservice`是基于内网可信网络设计的,所以出于安全考虑,禁止`apollo-configservice`和`apollo-adminservice`直接暴露在公网
2. 对敏感配置可以考虑开启[访问秘钥](#_62-%e9%85%8d%e7%bd%ae%e8%ae%bf%e9%97%ae%e5%af%86%e9%92%a5),从而只有经过身份验证的客户端才能访问敏感配置
3. 1.7.1及以上版本可以考虑为`apollo-adminservice`开启[访问控制](zh/deployment/distributed-deployment-guide?id=_6-admin-serviceaccesscontrolenabled-配置apollo-adminservice是否开启访问控制),从而只有合法的`apollo-portal`才能访问对应接口,增强安全性 | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/en/README.md | English version documentation of Apollo | English version documentation of Apollo | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/faq/faq.md | ## 1. Apollo是什么?
Apollo(阿波罗)是携程框架部门研发的配置管理平台,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性。
更多介绍,可以参考[Apollo配置中心介绍](zh/design/apollo-introduction)
## 2. Cluster是什么?
一个应用下不同实例的分组,比如典型的可以按照数据中心分,把A机房的应用实例分为一个集群,把B机房的应用实例分为另一个集群。
## 3. Namespace是什么?
一个应用下不同配置的分组。
请参考[Apollo核心概念之“Namespace”](zh/design/apollo-core-concept-namespace)
## 4. 我想要接入Apollo,该如何操作?
请参考[Apollo使用指南](zh/usage/apollo-user-guide)
## 5. 我的应用需要不同机房的配置不一样,Apollo是否能支持?
Apollo是支持的。请参考[Apollo使用指南](zh/usage/apollo-user-guide)中的`三、集群独立配置说明`
## 6. 我有多个应用需要使用同一份配置,Apollo是否能支持?
Apollo是支持的。请参考[Apollo使用指南](zh/usage/apollo-user-guide)中的`四、多个AppId使用同一份配置`
## 7. Apollo是否支持查看权限控制或者配置加密?
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
配置加密可以参考[spring-boot-encrypt demo项目](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-boot-encrypt)
## 8. 如果有多个config server,打包时如何配置meta server地址?
有多台meta server可以通过nginx反向代理,通过一个域名代理多个meta server实现ha。
## 9. Apollo相比于Spring Cloud Config有什么优势?
Spring Cloud Config的精妙之处在于它的配置存储于Git,这就天然的把配置的修改、权限、版本等问题隔离在外。通过这个设计使得Spring Cloud Config整体很简单,不过也带来了一些不便之处。
下面尝试做一个简单的小结:
| 功能点 | Apollo | Spring Cloud Config | 备注 |
|------------------|--------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------|
| 配置界面 | 一个界面管理不同环境、不同集群配置 | 无,需要通过git操作 | |
| 配置生效时间 | 实时 | 重启生效,或手动refresh生效 | Spring Cloud Config需要通过Git webhook,加上额外的消息队列才能支持实时生效 |
| 版本管理 | 界面上直接提供发布历史和回滚按钮 | 无,需要通过git操作 | |
| 灰度发布 | 支持 | 不支持 | |
| 授权、审核、审计 | 界面上直接支持,而且支持修改、发布权限分离 | 需要通过git仓库设置,且不支持修改、发布权限分离 | |
| 实例配置监控 | 可以方便的看到当前哪些客户端在使用哪些配置 | 不支持 | |
| 配置获取性能 | 快,通过数据库访问,还有缓存支持 | 较慢,需要从git clone repository,然后从文件系统读取 | |
| 客户端支持 | 原生支持所有Java和.Net应用,提供API支持其它语言应用,同时也支持Spring annotation获取配置 | 支持Spring应用,提供annotation获取配置 | Apollo的适用范围更广一些 |
## 10. Apollo和Disconf相比有什么优点?
由于我们自己并非Disconf的资深用户,所以无法主观地给出评价。
不过之前Apollo技术支持群中的热心网友[@Krast](https://github.com/krast)做了一个[开源配置中心对比矩阵](https://github.com/ctripcorp/apollo/files/983064/default.pdf),可以参考一下。 | ## 1. Apollo是什么?
Apollo(阿波罗)是携程框架部门研发的配置管理平台,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性。
更多介绍,可以参考[Apollo配置中心介绍](zh/design/apollo-introduction)
## 2. Cluster是什么?
一个应用下不同实例的分组,比如典型的可以按照数据中心分,把A机房的应用实例分为一个集群,把B机房的应用实例分为另一个集群。
## 3. Namespace是什么?
一个应用下不同配置的分组。
请参考[Apollo核心概念之“Namespace”](zh/design/apollo-core-concept-namespace)
## 4. 我想要接入Apollo,该如何操作?
请参考[Apollo使用指南](zh/usage/apollo-user-guide)
## 5. 我的应用需要不同机房的配置不一样,Apollo是否能支持?
Apollo是支持的。请参考[Apollo使用指南](zh/usage/apollo-user-guide)中的`三、集群独立配置说明`
## 6. 我有多个应用需要使用同一份配置,Apollo是否能支持?
Apollo是支持的。请参考[Apollo使用指南](zh/usage/apollo-user-guide)中的`四、多个AppId使用同一份配置`
## 7. Apollo是否支持查看权限控制或者配置加密?
从1.1.0版本开始,apollo-portal增加了查看权限的支持,可以支持配置某个环境只允许项目成员查看私有Namespace的配置。
这里的项目成员是指:
1. 项目的管理员
2. 具备该私有Namespace在该环境下的修改或发布权限
配置方式很简单,用超级管理员账号登录后,进入`管理员工具 - 系统参数`页面新增或修改`configView.memberOnly.envs`配置项即可。
![configView.memberOnly.envs](https://user-images.githubusercontent.com/837658/46456519-c155e100-c7e1-11e8-969b-8f332379fa29.png)
配置加密可以参考[spring-boot-encrypt demo项目](https://github.com/ctripcorp/apollo-use-cases/tree/master/spring-boot-encrypt)
## 8. 如果有多个config server,打包时如何配置meta server地址?
有多台meta server可以通过nginx反向代理,通过一个域名代理多个meta server实现ha。
## 9. Apollo相比于Spring Cloud Config有什么优势?
Spring Cloud Config的精妙之处在于它的配置存储于Git,这就天然的把配置的修改、权限、版本等问题隔离在外。通过这个设计使得Spring Cloud Config整体很简单,不过也带来了一些不便之处。
下面尝试做一个简单的小结:
| 功能点 | Apollo | Spring Cloud Config | 备注 |
|------------------|--------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------|
| 配置界面 | 一个界面管理不同环境、不同集群配置 | 无,需要通过git操作 | |
| 配置生效时间 | 实时 | 重启生效,或手动refresh生效 | Spring Cloud Config需要通过Git webhook,加上额外的消息队列才能支持实时生效 |
| 版本管理 | 界面上直接提供发布历史和回滚按钮 | 无,需要通过git操作 | |
| 灰度发布 | 支持 | 不支持 | |
| 授权、审核、审计 | 界面上直接支持,而且支持修改、发布权限分离 | 需要通过git仓库设置,且不支持修改、发布权限分离 | |
| 实例配置监控 | 可以方便的看到当前哪些客户端在使用哪些配置 | 不支持 | |
| 配置获取性能 | 快,通过数据库访问,还有缓存支持 | 较慢,需要从git clone repository,然后从文件系统读取 | |
| 客户端支持 | 原生支持所有Java和.Net应用,提供API支持其它语言应用,同时也支持Spring annotation获取配置 | 支持Spring应用,提供annotation获取配置 | Apollo的适用范围更广一些 |
## 10. Apollo和Disconf相比有什么优点?
由于我们自己并非Disconf的资深用户,所以无法主观地给出评价。
不过之前Apollo技术支持群中的热心网友[@Krast](https://github.com/krast)做了一个[开源配置中心对比矩阵](https://github.com/ctripcorp/apollo/files/983064/default.pdf),可以参考一下。 | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/usage/dotnet-sdk-user-guide.md | >注意:本文档适用对象是Apollo系统的使用者,如果你是公司内Apollo系统的开发者/维护人员,建议先参考[Apollo开发指南](zh/development/apollo-development-guide)。
#
# 一、准备工作
## 1.1 环境要求
* .Net: 4.0+
## 1.2 必选设置
Apollo客户端依赖于`AppId`,`Environment`等环境信息来工作,所以请确保阅读下面的说明并且做正确的配置:
### 1.2.1 AppId
AppId是应用的身份信息,是从服务端获取配置的一个重要信息。
请确保在app.config或web.config有AppID的配置,其中内容形如:
```xml
<?xml version="1.0"?>
<configuration>
<appSettings>
<!-- Change to the actual app id -->
<add key="AppID" value="100004458"/>
</appSettings>
</configuration>
```
> 注:app.id是用来标识应用身份的唯一id,格式为string。
### 1.2.2 Environment
Apollo支持应用在不同的环境有不同的配置,所以Environment是另一个从服务器获取配置的重要信息。
Environment通过配置文件来指定,文件位置为`C:\opt\settings\server.properties`,文件内容形如:
```properties
env=DEV
```
目前,`env`支持以下几个值(大小写不敏感):
* DEV
* Development environment
* FAT
* Feature Acceptance Test environment
* UAT
* User Acceptance Test environment
* PRO
* Production environment
### 1.2.3 服务地址
Apollo客户端针对不同的环境会从不同的服务器获取配置,所以请确保在app.config或web.config正确配置了服务器地址(Apollo.{ENV}.Meta),其中内容形如:
```xml
<?xml version="1.0"?>
<configuration>
<appSettings>
<!-- Change to the actual app id -->
<add key="AppID" value="100004458"/>
<!-- Should change the apollo config service url for each environment -->
<add key="Apollo.DEV.Meta" value="http://dev-configservice:8080"/>
<add key="Apollo.FAT.Meta" value="http://fat-configservice:8080"/>
<add key="Apollo.UAT.Meta" value="http://uat-configservice:8080"/>
<add key="Apollo.PRO.Meta" value="http://pro-configservice:8080"/>
</appSettings>
</configuration>
```
### 1.2.4 本地缓存路径
Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份,用于在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置,不影响应用正常运行。
本地缓存路径位于`C:\opt\data\{appId}\config-cache`,所以请确保`C:\opt\data\`目录存在,且应用有读写权限。
### 1.2.5 可选设置
**Cluster**(集群)
Apollo支持配置按照集群划分,也就是说对于一个appId和一个环境,对不同的集群可以有不同的配置。
如果需要使用这个功能,你可以通过以下方式来指定运行时的集群:
1. 通过App Config
* 我们可以在App.config文件中设置Apollo.Cluster来指定运行时集群(注意大小写)
* 例如,下面的截图配置指定了运行时的集群为SomeCluster
* ![apollo-net-apollo-cluster](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-net-apollo-cluster.png)
2. 通过配置文件
* 首先确保`C:\opt\settings\server.properties`在目标机器上存在
* 在这个文件中,可以设置数据中心集群,如`idc=xxx`
* 注意key为全小写
**Cluster Precedence**(集群顺序)
1. 如果`Apollo.Cluster`和`idc`同时指定:
* 我们会首先尝试从`Apollo.Cluster`指定的集群加载配置
* 如果没找到任何配置,会尝试从`idc`指定的集群加载配置
* 如果还是没找到,会从默认的集群(`default`)加载
2. 如果只指定了`Apollo.Cluster`:
* 我们会首先尝试从`Apollo.Cluster`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
3. 如果只指定了`idc`:
* 我们会首先尝试从`idc`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
4. 如果`Apollo.Cluster`和`idc`都没有指定:
* 我们会从默认的集群(`default`)加载配置
# 二、DLL引用
.Net客户端项目地址位于:[https://github.com/ctripcorp/apollo.net](https://github.com/ctripcorp/apollo.net)。
将项目下载到本地,切换到`Release`配置,编译Solution后会在`apollo.net\Apollo\bin\Release`中生成`Framework.Apollo.Client.dll`。
在应用中引用`Framework.Apollo.Client.dll`即可。
如果需要支持.Net Core的Apollo版本,可以参考[dotnet-core](https://github.com/ctripcorp/apollo.net/tree/dotnet-core)以及[nuget仓库](https://www.nuget.org/packages?q=Com.Ctrip.Framework.Apollo)
# 三、客户端用法
## 3.1 获取默认namespace的配置(application)
```c#
Config config = ConfigService.GetAppConfig(); //config instance is singleton for each namespace and is never null
string someKey = "someKeyFromDefaultNamespace";
string someDefaultValue = "someDefaultValueForTheKey";
string value = config.GetProperty(someKey, someDefaultValue);
```
通过上述的**config.GetProperty**可以获取到someKey对应的实时最新的配置值。
另外,配置值从内存中获取,所以不需要应用自己做缓存。
## 3.2 监听配置变化事件
监听配置变化事件只在应用真的关心配置变化,需要在配置变化时得到通知时使用,比如:数据库连接串变化后需要重建连接等。
如果只是希望每次都取到最新的配置的话,只需要按照上面的例子,调用**config.GetProperty**即可。
```c#
Config config = ConfigService.GetAppConfig(); //config instance is singleton for each namespace and is never null
config.ConfigChanged += new ConfigChangeEvent(OnChanged);
private void OnChanged(object sender, ConfigChangeEventArgs changeEvent)
{
Console.WriteLine("Changes for namespace {0}", changeEvent.Namespace);
foreach (string key in changeEvent.ChangedKeys)
{
ConfigChange change = changeEvent.GetChange(key);
Console.WriteLine("Change - key: {0}, oldValue: {1}, newValue: {2}, changeType: {3}", change.PropertyName, change.OldValue, change.NewValue, change.ChangeType);
}
}
```
## 3.3 获取公共Namespace的配置
```c#
string somePublicNamespace = "CAT";
Config config = ConfigService.GetConfig(somePublicNamespace); //config instance is singleton for each namespace and is never null
string someKey = "someKeyFromPublicNamespace";
string someDefaultValue = "someDefaultValueForTheKey";
string value = config.GetProperty(someKey, someDefaultValue);
```
## 3.4 Demo
apollo.net项目中有一个样例客户端的项目:`ApolloDemo`,具体信息可以参考[Apollo开发指南](zh/development/apollo-development-guide)中的[2.4 .Net样例客户端启动](zh/development/apollo-development-guide?id=_24-net样例客户端启动)部分。
>注:Apollo .Net客户端开源版目前默认会把日志直接输出到Console,大家可以自己实现Logging相关功能。
>
> 详见[https://github.com/ctripcorp/apollo.net/tree/master/Apollo/Logging/Spi](https://github.com/ctripcorp/apollo.net/tree/master/Apollo/Logging/Spi)
# 四、客户端设计
![client-architecture](https://github.com/ctripcorp/apollo/raw/master/doc/images/client-architecture.png)
上图简要描述了Apollo客户端的实现原理:
1. 客户端和服务端保持了一个长连接,从而能第一时间获得配置更新的推送。(通过Http Long Polling实现)
2. 客户端还会定时从Apollo配置中心服务端拉取应用的最新配置。
* 这是一个fallback机制,为了防止推送机制失效导致配置不更新
* 客户端定时拉取会上报本地版本,所以一般情况下,对于定时拉取的操作,服务端都会返回304 - Not Modified
* 定时频率默认为每5分钟拉取一次,客户端也可以通过App.config设置`Apollo.RefreshInterval`来覆盖,单位为毫秒。
3. 客户端从Apollo配置中心服务端获取到应用的最新配置后,会保存在内存中
4. 客户端会把从服务端获取到的配置在本地文件系统缓存一份
* 在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置
5. 应用程序可以从Apollo客户端获取最新的配置、订阅配置更新通知
# 五、本地开发模式
Apollo客户端还支持本地开发模式,这个主要用于当开发环境无法连接Apollo服务器的时候,比如在邮轮、飞机上做相关功能开发。
在本地开发模式下,Apollo只会从本地文件读取配置信息,不会从Apollo服务器读取配置。
可以通过下面的步骤开启Apollo本地开发模式。
## 5.1 修改环境
修改C:\opt\settings\server.properties文件,设置env为Local:
```properties
env=Local
```
## 5.2 准备本地配置文件
在本地开发模式下,Apollo客户端会从本地读取文件,所以我们需要事先准备好配置文件。
### 5.2.1 本地配置目录
本地配置目录位于:C:\opt\data\\{_appId_}\config-cache。
appId就是应用的appId,如100004458。
请确保该目录存在,且应用程序对该目录有读权限。
**【小技巧】** 推荐的方式是先在普通模式下使用Apollo,这样Apollo会自动创建该目录并在目录下生成配置文件。
### 5.2.2 本地配置文件
本地配置文件需要按照一定的文件名格式放置于本地配置目录下,文件名格式如下:
**_{appId}+{cluster}+{namespace}.json_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-net-config-cache.png)
文件内容以json格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```json
{
"request.timeout":"1000",
"batch":"2000"
}
```
## 5.3 修改配置
在本地开发模式下,Apollo不会实时监测文件内容是否有变化,所以如果修改了配置,需要重启应用生效。 | >注意:本文档适用对象是Apollo系统的使用者,如果你是公司内Apollo系统的开发者/维护人员,建议先参考[Apollo开发指南](zh/development/apollo-development-guide)。
#
# 一、准备工作
## 1.1 环境要求
* .Net: 4.0+
## 1.2 必选设置
Apollo客户端依赖于`AppId`,`Environment`等环境信息来工作,所以请确保阅读下面的说明并且做正确的配置:
### 1.2.1 AppId
AppId是应用的身份信息,是从服务端获取配置的一个重要信息。
请确保在app.config或web.config有AppID的配置,其中内容形如:
```xml
<?xml version="1.0"?>
<configuration>
<appSettings>
<!-- Change to the actual app id -->
<add key="AppID" value="100004458"/>
</appSettings>
</configuration>
```
> 注:app.id是用来标识应用身份的唯一id,格式为string。
### 1.2.2 Environment
Apollo支持应用在不同的环境有不同的配置,所以Environment是另一个从服务器获取配置的重要信息。
Environment通过配置文件来指定,文件位置为`C:\opt\settings\server.properties`,文件内容形如:
```properties
env=DEV
```
目前,`env`支持以下几个值(大小写不敏感):
* DEV
* Development environment
* FAT
* Feature Acceptance Test environment
* UAT
* User Acceptance Test environment
* PRO
* Production environment
### 1.2.3 服务地址
Apollo客户端针对不同的环境会从不同的服务器获取配置,所以请确保在app.config或web.config正确配置了服务器地址(Apollo.{ENV}.Meta),其中内容形如:
```xml
<?xml version="1.0"?>
<configuration>
<appSettings>
<!-- Change to the actual app id -->
<add key="AppID" value="100004458"/>
<!-- Should change the apollo config service url for each environment -->
<add key="Apollo.DEV.Meta" value="http://dev-configservice:8080"/>
<add key="Apollo.FAT.Meta" value="http://fat-configservice:8080"/>
<add key="Apollo.UAT.Meta" value="http://uat-configservice:8080"/>
<add key="Apollo.PRO.Meta" value="http://pro-configservice:8080"/>
</appSettings>
</configuration>
```
### 1.2.4 本地缓存路径
Apollo客户端会把从服务端获取到的配置在本地文件系统缓存一份,用于在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置,不影响应用正常运行。
本地缓存路径位于`C:\opt\data\{appId}\config-cache`,所以请确保`C:\opt\data\`目录存在,且应用有读写权限。
### 1.2.5 可选设置
**Cluster**(集群)
Apollo支持配置按照集群划分,也就是说对于一个appId和一个环境,对不同的集群可以有不同的配置。
如果需要使用这个功能,你可以通过以下方式来指定运行时的集群:
1. 通过App Config
* 我们可以在App.config文件中设置Apollo.Cluster来指定运行时集群(注意大小写)
* 例如,下面的截图配置指定了运行时的集群为SomeCluster
* ![apollo-net-apollo-cluster](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-net-apollo-cluster.png)
2. 通过配置文件
* 首先确保`C:\opt\settings\server.properties`在目标机器上存在
* 在这个文件中,可以设置数据中心集群,如`idc=xxx`
* 注意key为全小写
**Cluster Precedence**(集群顺序)
1. 如果`Apollo.Cluster`和`idc`同时指定:
* 我们会首先尝试从`Apollo.Cluster`指定的集群加载配置
* 如果没找到任何配置,会尝试从`idc`指定的集群加载配置
* 如果还是没找到,会从默认的集群(`default`)加载
2. 如果只指定了`Apollo.Cluster`:
* 我们会首先尝试从`Apollo.Cluster`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
3. 如果只指定了`idc`:
* 我们会首先尝试从`idc`指定的集群加载配置
* 如果没找到,会从默认的集群(`default`)加载
4. 如果`Apollo.Cluster`和`idc`都没有指定:
* 我们会从默认的集群(`default`)加载配置
# 二、DLL引用
.Net客户端项目地址位于:[https://github.com/ctripcorp/apollo.net](https://github.com/ctripcorp/apollo.net)。
将项目下载到本地,切换到`Release`配置,编译Solution后会在`apollo.net\Apollo\bin\Release`中生成`Framework.Apollo.Client.dll`。
在应用中引用`Framework.Apollo.Client.dll`即可。
如果需要支持.Net Core的Apollo版本,可以参考[dotnet-core](https://github.com/ctripcorp/apollo.net/tree/dotnet-core)以及[nuget仓库](https://www.nuget.org/packages?q=Com.Ctrip.Framework.Apollo)
# 三、客户端用法
## 3.1 获取默认namespace的配置(application)
```c#
Config config = ConfigService.GetAppConfig(); //config instance is singleton for each namespace and is never null
string someKey = "someKeyFromDefaultNamespace";
string someDefaultValue = "someDefaultValueForTheKey";
string value = config.GetProperty(someKey, someDefaultValue);
```
通过上述的**config.GetProperty**可以获取到someKey对应的实时最新的配置值。
另外,配置值从内存中获取,所以不需要应用自己做缓存。
## 3.2 监听配置变化事件
监听配置变化事件只在应用真的关心配置变化,需要在配置变化时得到通知时使用,比如:数据库连接串变化后需要重建连接等。
如果只是希望每次都取到最新的配置的话,只需要按照上面的例子,调用**config.GetProperty**即可。
```c#
Config config = ConfigService.GetAppConfig(); //config instance is singleton for each namespace and is never null
config.ConfigChanged += new ConfigChangeEvent(OnChanged);
private void OnChanged(object sender, ConfigChangeEventArgs changeEvent)
{
Console.WriteLine("Changes for namespace {0}", changeEvent.Namespace);
foreach (string key in changeEvent.ChangedKeys)
{
ConfigChange change = changeEvent.GetChange(key);
Console.WriteLine("Change - key: {0}, oldValue: {1}, newValue: {2}, changeType: {3}", change.PropertyName, change.OldValue, change.NewValue, change.ChangeType);
}
}
```
## 3.3 获取公共Namespace的配置
```c#
string somePublicNamespace = "CAT";
Config config = ConfigService.GetConfig(somePublicNamespace); //config instance is singleton for each namespace and is never null
string someKey = "someKeyFromPublicNamespace";
string someDefaultValue = "someDefaultValueForTheKey";
string value = config.GetProperty(someKey, someDefaultValue);
```
## 3.4 Demo
apollo.net项目中有一个样例客户端的项目:`ApolloDemo`,具体信息可以参考[Apollo开发指南](zh/development/apollo-development-guide)中的[2.4 .Net样例客户端启动](zh/development/apollo-development-guide?id=_24-net样例客户端启动)部分。
>注:Apollo .Net客户端开源版目前默认会把日志直接输出到Console,大家可以自己实现Logging相关功能。
>
> 详见[https://github.com/ctripcorp/apollo.net/tree/master/Apollo/Logging/Spi](https://github.com/ctripcorp/apollo.net/tree/master/Apollo/Logging/Spi)
# 四、客户端设计
![client-architecture](https://github.com/ctripcorp/apollo/raw/master/doc/images/client-architecture.png)
上图简要描述了Apollo客户端的实现原理:
1. 客户端和服务端保持了一个长连接,从而能第一时间获得配置更新的推送。(通过Http Long Polling实现)
2. 客户端还会定时从Apollo配置中心服务端拉取应用的最新配置。
* 这是一个fallback机制,为了防止推送机制失效导致配置不更新
* 客户端定时拉取会上报本地版本,所以一般情况下,对于定时拉取的操作,服务端都会返回304 - Not Modified
* 定时频率默认为每5分钟拉取一次,客户端也可以通过App.config设置`Apollo.RefreshInterval`来覆盖,单位为毫秒。
3. 客户端从Apollo配置中心服务端获取到应用的最新配置后,会保存在内存中
4. 客户端会把从服务端获取到的配置在本地文件系统缓存一份
* 在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置
5. 应用程序可以从Apollo客户端获取最新的配置、订阅配置更新通知
# 五、本地开发模式
Apollo客户端还支持本地开发模式,这个主要用于当开发环境无法连接Apollo服务器的时候,比如在邮轮、飞机上做相关功能开发。
在本地开发模式下,Apollo只会从本地文件读取配置信息,不会从Apollo服务器读取配置。
可以通过下面的步骤开启Apollo本地开发模式。
## 5.1 修改环境
修改C:\opt\settings\server.properties文件,设置env为Local:
```properties
env=Local
```
## 5.2 准备本地配置文件
在本地开发模式下,Apollo客户端会从本地读取文件,所以我们需要事先准备好配置文件。
### 5.2.1 本地配置目录
本地配置目录位于:C:\opt\data\\{_appId_}\config-cache。
appId就是应用的appId,如100004458。
请确保该目录存在,且应用程序对该目录有读权限。
**【小技巧】** 推荐的方式是先在普通模式下使用Apollo,这样Apollo会自动创建该目录并在目录下生成配置文件。
### 5.2.2 本地配置文件
本地配置文件需要按照一定的文件名格式放置于本地配置目录下,文件名格式如下:
**_{appId}+{cluster}+{namespace}.json_**
* appId就是应用自己的appId,如100004458
* cluster就是应用使用的集群,一般在本地模式下没有做过配置的话,就是default
* namespace就是应用使用配置namespace,一般是application
![client-local-cache](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/apollo-net-config-cache.png)
文件内容以json格式存储,比如如果有两个key,一个是request.timeout,另一个是batch,那么文件内容就是如下格式:
```json
{
"request.timeout":"1000",
"batch":"2000"
}
```
## 5.3 修改配置
在本地开发模式下,Apollo不会实时监测文件内容是否有变化,所以如果修改了配置,需要重启应用生效。 | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./.github/ISSUE_TEMPLATE/feature_request_en.md | ---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
| ---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/_coverpage.md | <img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="30%">
> A reliable configuration management system
- Multiple environments and clusters support
- Configuration changes take effect in real time
- Versioned and grayscale releases management
- Great authentication, authorization and audit control
[GitHub](https://github.com/ctripcorp/apollo/)
[Get Started](zh/README) | <img src="https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/logo/logo-simple.png" alt="apollo-logo" width="30%">
> A reliable configuration management system
- Multiple environments and clusters support
- Configuration changes take effect in real time
- Versioned and grayscale releases management
- Great authentication, authorization and audit control
[GitHub](https://github.com/ctripcorp/apollo/)
[Get Started](zh/README) | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/misc/apollo-benchmark.md | 很多同学关心Apollo的性能和可靠性,以下数据是采集携程内部生产环境单台机器的数据。监控工具是[Cat](https://github.com/dianping/cat)。
### 一、测试机器配置
#### 1.1 机器配置
4C12G
#### 1.2 JVM参数
````
-Xms6144m -Xmx6144m -Xss256k -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=384m -XX:NewSize=4096m -XX:MaxNewSize=4096m -XX:SurvivorRatio=8
-XX:+UseParNewGC -XX:ParallelGCThreads=4 -XX:MaxTenuringThreshold=9 -XX:+UseConcMarkSweepGC -XX:+DisableExplicitGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+ScavengeBeforeFullGC -XX:+UseCMSCompactAtFullCollection -XX:+CMSParallelRemarkEnabled -XX:CMSFullGCsBeforeCompaction=9 -XX:CMSInitiatingOccupancyFraction=60 -XX:+CMSClassUnloadingEnabled -XX:SoftRefLRUPolicyMSPerMB=0 -XX:+CMSPermGenSweepingEnabled -XX:CMSInitiatingPermOccupancyFraction=70 -XX:+ExplicitGCInvokesConcurrent -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCApplicationConcurrentTime -XX:+PrintHeapAtGC -XX:+HeapDumpOnOutOfMemoryError -XX:-OmitStackTraceInFastThrow -Duser.timezone=Asia/Shanghai -Dclient.encoding.override=UTF-8 -Dfile.encoding=UTF-8 -Djava.security.egd=file:/dev/./urandom
````
#### 1.3 JVM版本
1.8.0_60
#### 1.4 Apollo版本
0.9.0
#### 1.5 单台机器客户端连接数(客户端数)
5600
#### 1.6 集群总客户端连接数(客户端数)
10W+
### 二、性能指标
#### 2.1 获取配置Http接口响应时间
QPS: 160
平均响应时间: 0.1ms
95线响应时间: 0.3ms
999线响应时间: 2.5ms
>注:config service开启了配置缓存,更多信息可以参考[分布式部署指南中的缓存配置](zh/deployment/distributed-deployment-guide#_3-config-servicecacheenabled-是否开启配置缓存)
#### 2.2 Config Server GC情况
YGC: 平均2Min一次,一次耗时300ms
OGC: 平均1H一次,一次耗时380ms
#### 2.3 CPU指标
LoadAverage:0.5
System CPU利用率:6%
Process CPU利用率:8%
| 很多同学关心Apollo的性能和可靠性,以下数据是采集携程内部生产环境单台机器的数据。监控工具是[Cat](https://github.com/dianping/cat)。
### 一、测试机器配置
#### 1.1 机器配置
4C12G
#### 1.2 JVM参数
````
-Xms6144m -Xmx6144m -Xss256k -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=384m -XX:NewSize=4096m -XX:MaxNewSize=4096m -XX:SurvivorRatio=8
-XX:+UseParNewGC -XX:ParallelGCThreads=4 -XX:MaxTenuringThreshold=9 -XX:+UseConcMarkSweepGC -XX:+DisableExplicitGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+ScavengeBeforeFullGC -XX:+UseCMSCompactAtFullCollection -XX:+CMSParallelRemarkEnabled -XX:CMSFullGCsBeforeCompaction=9 -XX:CMSInitiatingOccupancyFraction=60 -XX:+CMSClassUnloadingEnabled -XX:SoftRefLRUPolicyMSPerMB=0 -XX:+CMSPermGenSweepingEnabled -XX:CMSInitiatingPermOccupancyFraction=70 -XX:+ExplicitGCInvokesConcurrent -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCApplicationConcurrentTime -XX:+PrintHeapAtGC -XX:+HeapDumpOnOutOfMemoryError -XX:-OmitStackTraceInFastThrow -Duser.timezone=Asia/Shanghai -Dclient.encoding.override=UTF-8 -Dfile.encoding=UTF-8 -Djava.security.egd=file:/dev/./urandom
````
#### 1.3 JVM版本
1.8.0_60
#### 1.4 Apollo版本
0.9.0
#### 1.5 单台机器客户端连接数(客户端数)
5600
#### 1.6 集群总客户端连接数(客户端数)
10W+
### 二、性能指标
#### 2.1 获取配置Http接口响应时间
QPS: 160
平均响应时间: 0.1ms
95线响应时间: 0.3ms
999线响应时间: 2.5ms
>注:config service开启了配置缓存,更多信息可以参考[分布式部署指南中的缓存配置](zh/deployment/distributed-deployment-guide#_3-config-servicecacheenabled-是否开启配置缓存)
#### 2.2 Config Server GC情况
YGC: 平均2Min一次,一次耗时300ms
OGC: 平均1H一次,一次耗时380ms
#### 2.3 CPU指标
LoadAverage:0.5
System CPU利用率:6%
Process CPU利用率:8%
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/usage/third-party-sdks-user-guide.md | ## 1. Go
### Apollo Go 客户端 1
项目地址:[zouyx/agollo](https://github.com/zouyx/agollo)
> 非常感谢网友@zouyx提供Go Apollo客户端的支持
### Apollo Go 客户端 2
项目地址:[philchia/agollo](https://github.com/philchia/agollo)
> 非常感谢网友@philchia提供Go Apollo客户端的支持
### Apollo Go 客户端 3
项目地址:[shima-park/agollo](https://github.com/shima-park/agollo)
> 非常感谢网友@shima-park提供Go Apollo客户端的支持
### Apollo Go 客户端 4
项目地址:[go-microservices/php_conf_agent](https://github.com/go-microservices/php_conf_agent)
> 非常感谢网友@GanymedeNil提供Go Apollo客户端的支持
### Apollo Go 客户端 5
项目地址:[hyperjiang/lunar](https://github.com/hyperjiang/lunar)
> 非常感谢网友@hyperjiang提供Go Apollo客户端的支持
### Apollo Go 客户端 6
项目地址:[tagconfig/tagconfig](https://github.com/tagconfig/tagconfig)
> 非常感谢网友@n0trace提供Go Apollo客户端的支持
### Apollo Go 客户端 7
项目地址:[go-chassis/go-archaius](https://github.com/go-chassis/go-archaius/tree/master/examples/apollo)
> 非常感谢网友@tianxiaoliang 和 @Shonminh提供Go Apollo客户端的支持
### Apollo Go 客户端 8
项目地址:[xhrg-product/apollo-client-golang](https://github.com/xhrg-product/apollo-client-golang)
> 非常感谢网友@xhrg提供Go Apollo客户端的支持
## 2. Python
### Apollo Python 客户端 1
项目地址:[pyapollo](https://github.com/filamoon/pyapollo)
> 非常感谢网友@filamoon提供Python Apollo客户端的支持
### Apollo Python 客户端 2
项目地址:[BruceWW-pyapollo](https://github.com/BruceWW/pyapollo)
> 非常感谢网友@BruceWW提供Python Apollo客户端的支持
### Apollo Python 客户端 3
项目地址:[xhrg-product/apollo-client-python](https://github.com/xhrg-product/apollo-client-python)
> 非常感谢网友@xhrg提供Python Apollo客户端的支持
## 3. NodeJS
### Apollo NodeJS 客户端 1
项目地址:[node-apollo](https://github.com/Quinton/node-apollo)
> 非常感谢网友@Quinton提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 2
项目地址:[ctrip-apollo](https://github.com/kaelzhang/ctrip-apollo)
> 非常感谢网友@kaelzhang提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 3
项目地址:[node-apollo-client](https://github.com/shinux/node-apollo-client)
> 非常感谢网友@shinux提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 4
项目地址:[ctrip-apollo-client](https://github.com/lvgithub/ctrip-apollo-client)
> 非常感谢网友@lvgithub提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 5
项目地址:[apollo-node](https://github.com/lengyuxuan/apollo-node)
> 非常感谢网友@lengyuxuan提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 6
项目地址:[egg-apollo-client](https://github.com/xuezier/egg-apollo-client)
> 非常感谢网友@xuezier提供NodeJS Apollo客户端的支持
## 4. PHP
### Apollo PHP 客户端
项目地址:[apollo-php-client](https://github.com/multilinguals/apollo-php-client)
> 非常感谢网友@t04041143提供PHP Apollo客户端的支持
## 5. C
### Apollo C 客户端
项目地址:[apollo-c-client](https://github.com/lzeqian/apollo)
> 非常感谢网友@lzeqian提供C Apollo客户端的支持 | ## 1. Go
### Apollo Go 客户端 1
项目地址:[zouyx/agollo](https://github.com/zouyx/agollo)
> 非常感谢网友@zouyx提供Go Apollo客户端的支持
### Apollo Go 客户端 2
项目地址:[philchia/agollo](https://github.com/philchia/agollo)
> 非常感谢网友@philchia提供Go Apollo客户端的支持
### Apollo Go 客户端 3
项目地址:[shima-park/agollo](https://github.com/shima-park/agollo)
> 非常感谢网友@shima-park提供Go Apollo客户端的支持
### Apollo Go 客户端 4
项目地址:[go-microservices/php_conf_agent](https://github.com/go-microservices/php_conf_agent)
> 非常感谢网友@GanymedeNil提供Go Apollo客户端的支持
### Apollo Go 客户端 5
项目地址:[hyperjiang/lunar](https://github.com/hyperjiang/lunar)
> 非常感谢网友@hyperjiang提供Go Apollo客户端的支持
### Apollo Go 客户端 6
项目地址:[tagconfig/tagconfig](https://github.com/tagconfig/tagconfig)
> 非常感谢网友@n0trace提供Go Apollo客户端的支持
### Apollo Go 客户端 7
项目地址:[go-chassis/go-archaius](https://github.com/go-chassis/go-archaius/tree/master/examples/apollo)
> 非常感谢网友@tianxiaoliang 和 @Shonminh提供Go Apollo客户端的支持
### Apollo Go 客户端 8
项目地址:[xhrg-product/apollo-client-golang](https://github.com/xhrg-product/apollo-client-golang)
> 非常感谢网友@xhrg提供Go Apollo客户端的支持
## 2. Python
### Apollo Python 客户端 1
项目地址:[pyapollo](https://github.com/filamoon/pyapollo)
> 非常感谢网友@filamoon提供Python Apollo客户端的支持
### Apollo Python 客户端 2
项目地址:[BruceWW-pyapollo](https://github.com/BruceWW/pyapollo)
> 非常感谢网友@BruceWW提供Python Apollo客户端的支持
### Apollo Python 客户端 3
项目地址:[xhrg-product/apollo-client-python](https://github.com/xhrg-product/apollo-client-python)
> 非常感谢网友@xhrg提供Python Apollo客户端的支持
## 3. NodeJS
### Apollo NodeJS 客户端 1
项目地址:[node-apollo](https://github.com/Quinton/node-apollo)
> 非常感谢网友@Quinton提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 2
项目地址:[ctrip-apollo](https://github.com/kaelzhang/ctrip-apollo)
> 非常感谢网友@kaelzhang提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 3
项目地址:[node-apollo-client](https://github.com/shinux/node-apollo-client)
> 非常感谢网友@shinux提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 4
项目地址:[ctrip-apollo-client](https://github.com/lvgithub/ctrip-apollo-client)
> 非常感谢网友@lvgithub提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 5
项目地址:[apollo-node](https://github.com/lengyuxuan/apollo-node)
> 非常感谢网友@lengyuxuan提供NodeJS Apollo客户端的支持
### Apollo NodeJS 客户端 6
项目地址:[egg-apollo-client](https://github.com/xuezier/egg-apollo-client)
> 非常感谢网友@xuezier提供NodeJS Apollo客户端的支持
## 4. PHP
### Apollo PHP 客户端
项目地址:[apollo-php-client](https://github.com/multilinguals/apollo-php-client)
> 非常感谢网友@t04041143提供PHP Apollo客户端的支持
## 5. C
### Apollo C 客户端
项目地址:[apollo-c-client](https://github.com/lzeqian/apollo)
> 非常感谢网友@lzeqian提供C Apollo客户端的支持 | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./docs/zh/development/email-template-samples.md | 在配置发布时候,可以发布信息邮件通知到相关的负责人,具体接入方式请参考[Apollo开发指南-3.2 Portal接入邮件服务](zh/development/apollo-development-guide#_32-portal接入邮件服务)。
以下为发布邮件和回滚邮件的模板内容样式,邮件模板为html格式,发送html格式的邮件时,可能需要做一些额外的处理,取决于每个公司的邮件服务实现。为了减少字符数,模板经过了压缩处理,可自行格式化提高可读性。
## email.template.framework
```html
<html><head><style type="text/css">.table{width:100%;max-width:100%;margin-bottom:20px;border-collapse:collapse;background-color:transparent}td{padding:8px;line-height:1.42857143;vertical-align:top;border:1px solid #ddd;border-top:1px solid #ddd}.table-bordered{border:1px solid #ddd}</style></head><body><h3>发布基本信息</h3><table class="table table-bordered"><tr><td width="10%"><b>AppId</b></td><td width="15%">#{appId}</td><td width="10%"><b>环境</b></td><td width="15%">#{env}</td><td width="10%"><b>集群</b></td><td width="15%">#{clusterName}</td><td width="10%"><b>Namespace</b></td><td width="15%">#{namespaceName}</td></tr><tr><td><b>发布者</b></td><td>#{operator}</td><td><b>发布时间</b></td><td>#{releaseTime}</td><td><b>发布标题</b></td><td>#{releaseTitle}</td><td><b>备注</b></td><td>#{releaseComment}</td></tr></table>#{diffModule}#{rulesModule}<br><a href="#{apollo.portal.address}/config/history.html?#/appid=#{appId}&env=#{env}&clusterName=#{clusterName}&namespaceName=#{namespaceName}&releaseHistoryId=#{releaseHistoryId}">点击查看详细的发布信息</a><br><br>如有Apollo使用问题请先查阅<a href="http://conf.ctripcorp.com/display/FRAM/Apollo">文档</a>,或直接回复本邮件咨询。</body></html>
```
> 注:使用此模板需要在 portal 的系统参数中配置 apollo.portal.address,指向 apollo portal 的地址
## email.template.release.module.diff
```html
<h3>变更的配置</h3>
<table class="table table-bordered">
<tr>
<td width="10%"><b>Type</b></td>
<td width="20%"><b>Key</b></td>
<td width="35%"><b>Old Value</b></td>
<td width="35%"><b>New Value</b></td>
</tr>
#{diffContent}
</table>
```
## email.template.rollback.module.diff
```html
<div>
<br><br>
<h3>变更的配置</h3>
<table class="table table-bordered">
<tr>
<td width="10%"><b>Type</b></td>
<td width="20%"><b>Key</b></td>
<td width="35%"><b>回滚前</b></td>
<td width="35%"><b>回滚后</b></td>
</tr>
#{diffContent}
</table>
<br>
</div>
```
## email.template.release.module.rules
```html
<div>
<br>
<h3>灰度规则</h3>
#{rulesContent}
<br>
</div>
```
## 发布邮件样例
![发布邮件模板](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/email-template-release.png)
## 回滚邮件样例
![回滚邮件模板](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/email-template-rollback.png) | 在配置发布时候,可以发布信息邮件通知到相关的负责人,具体接入方式请参考[Apollo开发指南-3.2 Portal接入邮件服务](zh/development/apollo-development-guide#_32-portal接入邮件服务)。
以下为发布邮件和回滚邮件的模板内容样式,邮件模板为html格式,发送html格式的邮件时,可能需要做一些额外的处理,取决于每个公司的邮件服务实现。为了减少字符数,模板经过了压缩处理,可自行格式化提高可读性。
## email.template.framework
```html
<html><head><style type="text/css">.table{width:100%;max-width:100%;margin-bottom:20px;border-collapse:collapse;background-color:transparent}td{padding:8px;line-height:1.42857143;vertical-align:top;border:1px solid #ddd;border-top:1px solid #ddd}.table-bordered{border:1px solid #ddd}</style></head><body><h3>发布基本信息</h3><table class="table table-bordered"><tr><td width="10%"><b>AppId</b></td><td width="15%">#{appId}</td><td width="10%"><b>环境</b></td><td width="15%">#{env}</td><td width="10%"><b>集群</b></td><td width="15%">#{clusterName}</td><td width="10%"><b>Namespace</b></td><td width="15%">#{namespaceName}</td></tr><tr><td><b>发布者</b></td><td>#{operator}</td><td><b>发布时间</b></td><td>#{releaseTime}</td><td><b>发布标题</b></td><td>#{releaseTitle}</td><td><b>备注</b></td><td>#{releaseComment}</td></tr></table>#{diffModule}#{rulesModule}<br><a href="#{apollo.portal.address}/config/history.html?#/appid=#{appId}&env=#{env}&clusterName=#{clusterName}&namespaceName=#{namespaceName}&releaseHistoryId=#{releaseHistoryId}">点击查看详细的发布信息</a><br><br>如有Apollo使用问题请先查阅<a href="http://conf.ctripcorp.com/display/FRAM/Apollo">文档</a>,或直接回复本邮件咨询。</body></html>
```
> 注:使用此模板需要在 portal 的系统参数中配置 apollo.portal.address,指向 apollo portal 的地址
## email.template.release.module.diff
```html
<h3>变更的配置</h3>
<table class="table table-bordered">
<tr>
<td width="10%"><b>Type</b></td>
<td width="20%"><b>Key</b></td>
<td width="35%"><b>Old Value</b></td>
<td width="35%"><b>New Value</b></td>
</tr>
#{diffContent}
</table>
```
## email.template.rollback.module.diff
```html
<div>
<br><br>
<h3>变更的配置</h3>
<table class="table table-bordered">
<tr>
<td width="10%"><b>Type</b></td>
<td width="20%"><b>Key</b></td>
<td width="35%"><b>回滚前</b></td>
<td width="35%"><b>回滚后</b></td>
</tr>
#{diffContent}
</table>
<br>
</div>
```
## email.template.release.module.rules
```html
<div>
<br>
<h3>灰度规则</h3>
#{rulesContent}
<br>
</div>
```
## 发布邮件样例
![发布邮件模板](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/email-template-release.png)
## 回滚邮件样例
![回滚邮件模板](https://raw.githubusercontent.com/ctripcorp/apollo/master/doc/images/email-template-rollback.png) | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./apollo-core/src/main/java/com/ctrip/framework/foundation/Foundation.java | package com.ctrip.framework.foundation;
import com.ctrip.framework.foundation.internals.NullProviderManager;
import com.ctrip.framework.foundation.internals.ServiceBootstrap;
import com.ctrip.framework.foundation.spi.ProviderManager;
import com.ctrip.framework.foundation.spi.provider.ApplicationProvider;
import com.ctrip.framework.foundation.spi.provider.NetworkProvider;
import com.ctrip.framework.foundation.spi.provider.ServerProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class Foundation {
private static final Logger logger = LoggerFactory.getLogger(Foundation.class);
private static Object lock = new Object();
private static volatile ProviderManager s_manager;
// Encourage early initialization and fail early if it happens.
static {
getManager();
}
private static ProviderManager getManager() {
try {
if (s_manager == null) {
// Double locking to make sure only one thread initializes ProviderManager.
synchronized (lock) {
if (s_manager == null) {
s_manager = ServiceBootstrap.loadFirst(ProviderManager.class);
}
}
}
return s_manager;
} catch (Throwable ex) {
s_manager = new NullProviderManager();
logger.error("Initialize ProviderManager failed.", ex);
return s_manager;
}
}
public static String getProperty(String name, String defaultValue) {
try {
return getManager().getProperty(name, defaultValue);
} catch (Throwable ex) {
logger.error("getProperty for {} failed.", name, ex);
return defaultValue;
}
}
public static NetworkProvider net() {
try {
return getManager().provider(NetworkProvider.class);
} catch (Exception ex) {
logger.error("Initialize NetworkProvider failed.", ex);
return NullProviderManager.provider;
}
}
public static ServerProvider server() {
try {
return getManager().provider(ServerProvider.class);
} catch (Exception ex) {
logger.error("Initialize ServerProvider failed.", ex);
return NullProviderManager.provider;
}
}
public static ApplicationProvider app() {
try {
return getManager().provider(ApplicationProvider.class);
} catch (Exception ex) {
logger.error("Initialize ApplicationProvider failed.", ex);
return NullProviderManager.provider;
}
}
}
| package com.ctrip.framework.foundation;
import com.ctrip.framework.foundation.internals.NullProviderManager;
import com.ctrip.framework.foundation.internals.ServiceBootstrap;
import com.ctrip.framework.foundation.spi.ProviderManager;
import com.ctrip.framework.foundation.spi.provider.ApplicationProvider;
import com.ctrip.framework.foundation.spi.provider.NetworkProvider;
import com.ctrip.framework.foundation.spi.provider.ServerProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public abstract class Foundation {
private static final Logger logger = LoggerFactory.getLogger(Foundation.class);
private static Object lock = new Object();
private static volatile ProviderManager s_manager;
// Encourage early initialization and fail early if it happens.
static {
getManager();
}
private static ProviderManager getManager() {
try {
if (s_manager == null) {
// Double locking to make sure only one thread initializes ProviderManager.
synchronized (lock) {
if (s_manager == null) {
s_manager = ServiceBootstrap.loadFirst(ProviderManager.class);
}
}
}
return s_manager;
} catch (Throwable ex) {
s_manager = new NullProviderManager();
logger.error("Initialize ProviderManager failed.", ex);
return s_manager;
}
}
public static String getProperty(String name, String defaultValue) {
try {
return getManager().getProperty(name, defaultValue);
} catch (Throwable ex) {
logger.error("getProperty for {} failed.", name, ex);
return defaultValue;
}
}
public static NetworkProvider net() {
try {
return getManager().provider(NetworkProvider.class);
} catch (Exception ex) {
logger.error("Initialize NetworkProvider failed.", ex);
return NullProviderManager.provider;
}
}
public static ServerProvider server() {
try {
return getManager().provider(ServerProvider.class);
} catch (Exception ex) {
logger.error("Initialize ServerProvider failed.", ex);
return NullProviderManager.provider;
}
}
public static ApplicationProvider app() {
try {
return getManager().provider(ApplicationProvider.class);
} catch (Exception ex) {
logger.error("Initialize ApplicationProvider failed.", ex);
return NullProviderManager.provider;
}
}
}
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./apollo-core/src/test/java/com/ctrip/framework/apollo/core/signature/HmacSha1UtilsTest.java | package com.ctrip.framework.apollo.core.signature;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
/**
* @author nisiyong
*/
public class HmacSha1UtilsTest {
@Test
public void testSignString() {
String stringToSign = "1576478257344\n/configs/100004458/default/application?ip=10.0.0.1";
String accessKeySecret = "df23df3f59884980844ff3dada30fa97";
String actualSignature = HmacSha1Utils.signString(stringToSign, accessKeySecret);
String expectedSignature = "EoKyziXvKqzHgwx+ijDJwgVTDgE=";
assertEquals(expectedSignature, actualSignature);
}
} | package com.ctrip.framework.apollo.core.signature;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
/**
* @author nisiyong
*/
public class HmacSha1UtilsTest {
@Test
public void testSignString() {
String stringToSign = "1576478257344\n/configs/100004458/default/application?ip=10.0.0.1";
String accessKeySecret = "df23df3f59884980844ff3dada30fa97";
String actualSignature = HmacSha1Utils.signString(stringToSign, accessKeySecret);
String expectedSignature = "EoKyziXvKqzHgwx+ijDJwgVTDgE=";
assertEquals(expectedSignature, actualSignature);
}
} | -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./scripts/helm/apollo-service/Chart.yaml | apiVersion: v2
name: apollo-service
description: A Helm chart for Apollo Config Service and Apollo Admin Service
type: application
version: 0.2.0
appVersion: 1.8.0-SNAPSHOT
home: https://github.com/ctripcorp/apollo
icon: https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-portal/src/main/resources/static/img/logo-simple.png
maintainers:
- name: nobodyiam
email: [email protected]
url: https://github.com/nobodyiam
| apiVersion: v2
name: apollo-service
description: A Helm chart for Apollo Config Service and Apollo Admin Service
type: application
version: 0.2.0
appVersion: 1.8.0-SNAPSHOT
home: https://github.com/ctripcorp/apollo
icon: https://raw.githubusercontent.com/ctripcorp/apollo/master/apollo-portal/src/main/resources/static/img/logo-simple.png
maintainers:
- name: nobodyiam
email: [email protected]
url: https://github.com/nobodyiam
| -1 |
apolloconfig/apollo | 3,489 | doc update | ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| nobodyiam | "2021-01-10T09:40:04Z" | "2021-01-10T09:40:32Z" | dbe243dec3b56d398c0627add53b5ec2c0ac92cb | b4188031befb158dc9f3b37bcec08af3663e8522 | doc update. ## What's the purpose of this PR
add known users and adjust sidebar
Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] Read the [Contributing Guide](https://github.com/ctripcorp/apollo/blob/master/CONTRIBUTING.md) before making this pull request.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit tests to verify the code.
- [x] Run `mvn clean test` to make sure this pull request doesn't break anything.
| ./apollo-portal/src/main/resources/static/vendor/bootstrap/fonts/glyphicons-halflings-regular.ttf |