SylviaBABY commented on code in PR #7256: URL: https://github.com/apache/apisix/pull/7256#discussion_r897867233
########## docs/en/latest/architecture-design/deployment-role.md: ########## @@ -0,0 +1,133 @@ +--- +title: Deployment Role +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +## Concept + +Previously, the DP (data plane) and the CP (control plane) are not separate explicitly. +Although we clearly distinguish the different responsibilities of DP and CP in the documentation, not everyone has correctly deployed APISIX in the production environment. + +Therefore, we introduce new concepts called deployment modes/roles, to help users deploy APISIX easily and safely. +APISIX under different deployment modes will act differently. + +The table below shows the relationship among deployment modes and roles: + +| Deployment Modes | Role | Description | +|------------------|----------------------------|------------------------------------------------------------------------------------------| +| traditional | traditional | DP + CP are deployed together by default. People need to disable `enable_admin` manually | +| decoupled | data_plane / control_plane | DP and CP are deployed independently. | +| standalone | data_plane | Only DP, load the all configurations from local yaml file | + +## Deployment Modes + +### Traditional + + + +In the traditional deployment mode, one instance can be both DP & CP. +There will be a `conf server` listens on Unix socket and acts as a proxy between APISIX and etcd. +Both the DP part and CP part of the instance will connect to the `conf server` via HTTP protocol. + +Here is the example of configuration: + +```yaml title="conf/config.yaml" +deployment: + role: traditional + role_traditional: + config_provider: etcd + etcd: + host: + - http://xxxx + prefix: /apisix + timeout: 30 +``` + +### Decoupled + + + +The instance deployed as data_plane will: + +1. Fetch configurations from control plane, the default port is 9280 Review Comment: ```suggestion 1. Fetch configurations from the CP, the default port is 9280 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
