[apisix] branch master updated: docs: update certificate names in decoupled mode and add configurations for different deployment modes to `config-default.yaml` (#9895)

[monkeydluffy]

This is an automated email from the ASF dual-hosted git repository.

monkeydluffy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 112ff549b docs: update certificate names in decoupled mode and add 
configurations for different deployment modes to `config-default.yaml` (#9895)
112ff549b is described below

commit 112ff549b63bfec13cdb75b0a711a7e38f2caa24
Author: Traky Deng <trakyd...@gmail.com>
AuthorDate: Wed Jul 26 11:33:08 2023 +0800

    docs: update certificate names in decoupled mode and add configurations for 
different deployment modes to `config-default.yaml` (#9895)
---
 conf/config-default.yaml           | 29 +++++++++++++++++++++++++++--
 docs/en/latest/deployment-modes.md | 24 ++++++++++++------------
 2 files changed, 39 insertions(+), 14 deletions(-)

diff --git a/conf/config-default.yaml b/conf/config-default.yaml
index ef490f742..3115749d0 100755
--- a/conf/config-default.yaml
+++ b/conf/config-default.yaml
@@ -611,9 +611,34 @@ plugin_attr:          # Plugin attributes
                                                               # write access 
to this file for security.
 
 deployment:                    # Deployment configurations
-  role: traditional            # Set deployment mode: traditional, 
control_plane, data_plane.
+  role: traditional            # Set deployment mode: traditional, 
control_plane, or data_plane.
   role_traditional:
     config_provider: etcd      # Set the configuration center.
+
+    # role_data_plane:         # Set data plane details if role is data_plane.
+    #   config_provider: control_plane          # Set the configuration 
center: control_plane, or yaml.
+    #   control_plane:                          # Set control plane details if 
config_provider is control_plane.
+    #     host:                                 # Set the address of control 
plane.
+    #       - https://${control_plane_IP}:9280
+    #     prefix: /apisix                       # Set etcd prefix.
+    #     timeout: 30                           # Set timeout in seconds.
+    #   certs:
+    #     cert: /path/to/client.crt           # Set path to the client 
certificate.
+    #     cert_key: /path/to/client.key       # Set path to the client key.
+    #     trusted_ca_cert: /path/to/ca.crt    # Set path to the trusted CA 
certificate.
+
+    # role_control_plane:         # Set control plane details if role is 
control_plane.
+    #   config_provider: etcd     # Set the configuration center.
+    #   conf_server:
+    #     listen: 0.0.0.0:9280                # Set the address of the conf 
server.
+    #     cert: /path/to/server.crt           # Set path to the server 
certificate.
+    #     cert_key: /path/to/server.key       # Set path to the server key.
+    #     client_ca_cert: /path/to/ca.crt     # Set path to the trusted CA 
certificate.
+    # certs:
+    #   cert: /path/to/client.crt             # Set path to the client 
certificate.
+    #   cert_key: /path/to/client.key         # Set path to the client key.
+    #   trusted_ca_cert: /path/to/ca.crt      # Set path to the trusted CA 
certificate.
+
   admin:                       # Admin API
     admin_key_required: true   # Enable Admin API authentication by default 
for security.
     admin_key:
@@ -646,7 +671,7 @@ deployment:                    # Deployment configurations
   etcd:
     host:                         # Set etcd address(es) in the same etcd 
cluster.
       - "http://127.0.0.1:2379";   # If TLS is enabled for etcd, use 
https://127.0.0.1:2379.
-    prefix: /apisix               # Set prefix in etcd.
+    prefix: /apisix               # Set etcd prefix.
     use_grpc: false               # Use gRPC (experimental) for etcd 
configuration sync.
     timeout: 30                   # Set timeout in seconds.
                                   # Set a higher timeout (e.g. an hour) if 
`use_grpc` is true.
diff --git a/docs/en/latest/deployment-modes.md 
b/docs/en/latest/deployment-modes.md
index e5c7b9175..c5687d84b 100644
--- a/docs/en/latest/deployment-modes.md
+++ b/docs/en/latest/deployment-modes.md
@@ -97,9 +97,9 @@ deployment:
            prefix: /apisix
            timeout: 30
     certs:
-        cert: /path/to/ca-cert
-        cert_key: /path/to/ca-cert
-        trusted_ca_cert: /path/to/ca-cert
+        cert: /path/to/client.crt
+        cert_key: /path/to/client.key
+        trusted_ca_cert: /path/to/ca.crt
 #END
 ```
 
@@ -117,18 +117,18 @@ deployment:
         config_provider: etcd
         conf_server:
             listen: 0.0.0.0:9280
-            cert: /path/to/ca-cert
-            cert_key: /path/to/ca-cert
-            client_ca_cert: /path/to/ca-cert
+            cert: /path/to/server.crt
+            cert_key: /path/to/server.key
+            client_ca_cert: /path/to/ca.crt
     etcd:
        host:
            - https://${etcd_IP}:${etcd_Port}
        prefix: /apisix
        timeout: 30
     certs:
-        cert: /path/to/ca-cert
-        cert_key: /path/to/ca-cert
-        trusted_ca_cert: /path/to/ca-cert
+        cert: /path/to/client.crt
+        cert_key: /path/to/client.key
+        trusted_ca_cert: /path/to/ca.crt
 #END
 ```
 
@@ -143,15 +143,15 @@ deployment:
         config_provider: etcd
         conf_server:
             listen: 0.0.0.0:9280
-            cert: /path/to/ca-cert
-            cert_key: /path/to/ca-cert
+            cert: /path/to/server.crt
+            cert_key: /path/to/server.key
     etcd:
        host:
            - https://${etcd_IP}:${etcd_Port}
        prefix: /apisix
        timeout: 30
     certs:
-        trusted_ca_cert: /path/to/ca-cert
+        trusted_ca_cert: /path/to/ca.crt
 #END
 ```