You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ti...@apache.org on 2020/07/17 01:43:01 UTC
[servicecomb-service-center] branch master updated: update the
links to sphinx (#670)
This is an automated email from the ASF dual-hosted git repository.
tianxiaoliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-service-center.git
The following commit(s) were added to refs/heads/master by this push:
new 66215bb update the links to sphinx (#670)
66215bb is described below
commit 66215bb9917b44925324b826f0f2a8d0666c217e
Author: hityc2019 <48...@users.noreply.github.com>
AuthorDate: Fri Jul 17 09:42:53 2020 +0800
update the links to sphinx (#670)
---
README.md | 16 ++++----
docs/design-guides.rst | 2 +-
docs/design-guides/design.md | 48 ----------------------
docs/design-guides/design.rst | 70 ++++++++++++++++++++++++++++++++
docs/index.rst | 8 ----
docs/plugin-tracing-guides.rst | 2 +-
docs/plugins-tracing/tracing.md | 38 -----------------
docs/plugins-tracing/tracing.rst | 43 ++++++++++++++++++++
docs/user-guides.rst | 2 +-
docs/user-guides/integration-grafana.md | 16 --------
docs/user-guides/integration-grafana.rst | 17 ++++++++
11 files changed, 141 insertions(+), 121 deletions(-)
diff --git a/README.md b/README.md
index c90160b..f8df5d8 100644
--- a/README.md
+++ b/README.md
@@ -23,18 +23,18 @@ It provides out of box support for metrics and tracing. It has a web portal to m
- **[`Portal`](/frontend)**: Awesome web portal
- **Fault tolerance**: Multiple fault tolerance mechanism and design in the architecture
- **Performance**: Performance/Caching design
- - **[`Metrics`](/docs/user-guides/integration-grafana.md)**: Able to expose Prometheus metric API automatically
- - **[`Tracing`](/docs/plugins-tracing/tracing.md)**: Able to report tracing data to Zipkin server
- - **[`Pluginable`](/docs/design-guides/plugin.md)**: Able to load custom authentication, tls and other dynamic libraries
- - **[`CLI`](/docs/intro/scctl.md)**: Easy to control service center
- - **[`Kubernetes`](/docs/dev-guides/kubeclusters.rst)**: Embrace kubernetes ecosystem and support multi cluster service discovery
- - **[`Datacenters`](/docs/dev-guides/multidcs.rst)**: Additional layer of abstraction to clusters deployed in multiple datacenters
- - **[`Aggregation`](/docs/design-guides/aggregator-design.PNG)**: Able to aggregate microservices from multiple registry platforms and
+ - **[`Metrics`](https://service-center.readthedocs.io/en/latest/user-guides/integration-grafana.html)**: Able to expose Prometheus metric API automatically
+ - **[`Tracing`](https://service-center.readthedocs.io/en/latest/plugins-tracing/tracing.html)**: Able to report tracing data to Zipkin server
+ - **[`Pluginable`](https://service-center.readthedocs.io/en/latest/design-guides/plugin.html)**: Able to load custom authentication, tls and other dynamic libraries
+ - **[`CLI`](https://service-center.readthedocs.io/en/latest/intro/scctl.html)**: Easy to control service center
+ - **[`Kubernetes`](https://service-center.readthedocs.io/en/latest/dev-guides/kubeclusters.html)**: Embrace kubernetes ecosystem and support multi cluster service discovery
+ - **[`Datacenters`](https://service-center.readthedocs.io/en/latest/dev-guides/multidcs.html)**: Additional layer of abstraction to clusters deployed in multiple datacenters
+ - **[`Aggregation`](https://service-center.readthedocs.io/en/latest/design-guides/design.html)**: Able to aggregate microservices from multiple registry platforms and
support platform registry and client side registry at the same time
## Documentation
-Project documentation is available on the [ServiceComb website][servicecomb-website]. You can also find full document [`here`](/docs).
+Project documentation is available on the [ServiceComb website][servicecomb-website]. You can also find full document [`here`](https://service-center.readthedocs.io/).
[servicecomb-website]: http://servicecomb.apache.org/
diff --git a/docs/design-guides.rst b/docs/design-guides.rst
index 564b115..b32d677 100644
--- a/docs/design-guides.rst
+++ b/docs/design-guides.rst
@@ -5,6 +5,6 @@ Design Guides
:maxdepth: 4
:glob:
- design-guides/design.md
+ design-guides/design.rst
design-guides/plugin.md
diff --git a/docs/design-guides/design.md b/docs/design-guides/design.md
deleted file mode 100644
index 7ceb003..0000000
--- a/docs/design-guides/design.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# Design Guides
-
-## Service-Center Design
-
-Service-Center(SC) is a service registry that allows services to register their instance information and to discover providers of a given service.
-Generally, SC uses etcd to store all the information of micro-service and its instances.
-
-```eval_rst
-.. image:: aggregator-design.PNG
-```
-
-- **API Layer**: To expose the RESTful and gRPC service.
-- **Metedata**: The business logic to manage microservice, instance, schema, tag, dependency and ACL rules.
-- **Server Core**: Including data model, requests handle chain and so on.
-- **Aggregator**: It is the bridge between Core and Registry, includes the cache manager and indexer of registry.
-- **Registry Adaptor**: An abstract layer of registry, exposing a unified interface for upper layer calls.
-
-Below is the diagram stating the working principles and flow of SC.
-
-#### On StartUp
-Here describes a standard client registration process.
-We assume that micro-services are written using
-[java-chassis](https://github.com/ServiceComb/java-chassis) sdk or
-[go-chassis](https://github.com/go-chassis/go-chassis) sdk.
-So when micro-service boots up then java-chassis sdk does the following list of tasks.
-
-1. On startup provider registers the micro-service to SC if not registered earlier and also register its instance information like its Ip and Port on which instance is running.
-2. SC stores the provider information in etcd.
-3. On startup consumer retrieves the list of all provider instance from SC using the micro-service name of the provider.
-4. Consumer sdk stores all the information of provider instances in its cache.
-5. Consumer sdk creates a web socket connection to SC to watch all the provider instance information, if there is any change in the provider then sdk updates it's cache information.
-
-```eval_rst
-.. image:: onStartup.PNG
-```
-
-#### Communication between Consumer -> Provider
-Once the bootup is successful then the consumer can communicate with providers flawlessly, below is the diagram illustrating the communication between provider and consumer.
-
-```eval_rst
-.. image:: communication.PNG
-```
-
-Provider instance regularly sends heartbeat signal every 30 seconds to SC, if SC does not receive the heartbeat for particular instance then the information in etcd expires and the provider instance information is removed.
-Consumer watches the information of provider instances from SC and if there is any change then the cache is updated.
-When Consumer needs to communicate to Provider then consumer reads endpoints of the provider instances from cache and do loadbalancing to communicate to Provider.
-
-Note: Feel free to contribute to this document.
diff --git a/docs/design-guides/design.rst b/docs/design-guides/design.rst
new file mode 100644
index 0000000..2dd0a20
--- /dev/null
+++ b/docs/design-guides/design.rst
@@ -0,0 +1,70 @@
+Design Guides
+=============
+
+Service-Center Design
+---------------------
+
+Service-Center(SC) is a service registry that allows services to
+register their instance information and to discover providers of a given
+service. Generally, SC uses etcd to store all the information of
+micro-service and its instances.
+
+.. image:: aggregator-design.PNG
+
+- **API Layer**: To expose the RESTful and gRPC service.
+- **Metedata**: The business logic to manage microservice, instance,
+ schema, tag, dependency and ACL rules.
+- **Server Core**: Including data model, requests handle chain and so
+ on.
+- **Aggregator**: It is the bridge between Core and Registry, includes
+ the cache manager and indexer of registry.
+- **Registry Adaptor**: An abstract layer of registry, exposing a
+ unified interface for upper layer calls.
+
+Below is the diagram stating the working principles and flow of SC.
+
+On StartUp
+^^^^^^^^^^
+
+Here describes a standard client registration process. We assume that
+micro-services are written using `java-chassis`_ sdk or `go-chassis`_
+sdk. So when micro-service boots up then java-chassis sdk does the
+following list of tasks.
+
+1. On startup provider registers the micro-service to SC if not
+ registered earlier and also register its instance information like
+ its Ip and Port on which instance is running.
+2. SC stores the provider information in etcd.
+3. On startup consumer retrieves the list of all provider instance from
+ SC using the micro-service name of the provider.
+4. Consumer sdk stores all the information of provider instances in its
+ cache.
+5. Consumer sdk creates a web socket connection to SC to watch all the
+ provider instance information, if there is any change in the provider
+ then sdk updates it’s cache information.
+
+.. image:: onStartup.PNG
+
+Communication between Consumer -> Provider
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Once the bootup is successful then the consumer can communicate with
+providers flawlessly, below is the diagram illustrating the
+communication between provider and consumer.
+
+.. image:: communication.PNG
+
+| Provider instance regularly sends heartbeat signal every 30 seconds to
+ SC, if SC does not receive the heartbeat for particular instance then
+ the information in etcd expires and the provider instance information
+ is removed.
+| Consumer watches the information of provider instances from SC and if
+ there is any change then the cache is updated.
+| When Consumer needs to communicate to Provider then consumer reads
+ endpoints of the provider instances from cache and do loadbalancing to
+ communicate to Provider.
+
+Note: Feel free to contribute to this document.
+
+.. _java-chassis: https://github.com/ServiceComb/java-chassis
+.. _go-chassis: https://github.com/go-chassis/go-chassis
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index a624c97..d7c7e76 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -33,11 +33,3 @@ Welcome to servicecomb-service-center's documentation!
:caption: Release Version
release
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/plugin-tracing-guides.rst b/docs/plugin-tracing-guides.rst
index bc739db..81883c5 100644
--- a/docs/plugin-tracing-guides.rst
+++ b/docs/plugin-tracing-guides.rst
@@ -5,5 +5,5 @@ Tracing Plugins
:maxdepth: 4
:glob:
- plugins-tracing/tracing.md
+ plugins-tracing/tracing.rst
diff --git a/docs/plugins-tracing/tracing.md b/docs/plugins-tracing/tracing.md
deleted file mode 100644
index e2ae7a2..0000000
--- a/docs/plugins-tracing/tracing.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Report trace data
-
-## Edit the configuration of the tracing plugin
-```bash
-trace_plugin='buildin' # or empty
-```
-
-## To zipkin server
-
-```eval_rst
-.. image:: tracing-server.PNG
-```
-
-### Add the zipkin server endpoint
-```
-# Export the environments
-export TRACING_COLLECTOR=server
-export TRACING_SERVER_ADDRESS=http://127.0.0.1:9411 # zipkin server endpoint
-
-# Start the Service-center
-./servicecenter
-```
-
-## To file
-
-```eval_rst
-.. image:: tracing-file.PNG
-```
-
-### Customize the path of trace data file
-```
-# Export the environments
-export TRACING_COLLECTOR=file
-export TRACING_FILE_PATH=/tmp/servicecenter.trace # if not set, use ${work directory}/SERVICECENTER.trace
-
-# Start the Service-center
-./servicecenter
-```
diff --git a/docs/plugins-tracing/tracing.rst b/docs/plugins-tracing/tracing.rst
new file mode 100644
index 0000000..88c66c2
--- /dev/null
+++ b/docs/plugins-tracing/tracing.rst
@@ -0,0 +1,43 @@
+Report trace data
+=================
+
+Edit the configuration of the tracing plugin
+--------------------------------------------
+
+.. code:: bash
+
+ trace_plugin='buildin' # or empty
+
+To zipkin server
+----------------
+
+.. image:: tracing-server.PNG
+
+Add the zipkin server endpoint
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ # Export the environments
+ export TRACING_COLLECTOR=server
+ export TRACING_SERVER_ADDRESS=http://127.0.0.1:9411 # zipkin server endpoint
+
+ # Start the Service-center
+ ./servicecenter
+
+To file
+-------
+
+.. image:: tracing-file.PNG
+
+Customize the path of trace data file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ # Export the environments
+ export TRACING_COLLECTOR=file
+ export TRACING_FILE_PATH=/tmp/servicecenter.trace # if not set, use ${work directory}/SERVICECENTER.trace
+
+ # Start the Service-center
+ ./servicecenter
\ No newline at end of file
diff --git a/docs/user-guides.rst b/docs/user-guides.rst
index 32cef85..a06bafc 100644
--- a/docs/user-guides.rst
+++ b/docs/user-guides.rst
@@ -8,5 +8,5 @@ User Guides
user-guides/pr-raising-guide.md
user-guides/security-tls.md
user-guides/sc-cluster.rst
- user-guides/integration-grafana.md
+ user-guides/integration-grafana.rst
user-guides/rbac.md
diff --git a/docs/user-guides/integration-grafana.md b/docs/user-guides/integration-grafana.md
deleted file mode 100644
index effb7b9..0000000
--- a/docs/user-guides/integration-grafana.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Integrate with Grafana
-
-As Service-Center uses Prometheus lib to report metrics.
-Then it is easy to integrate with Grafana.
-Here is a [DEMO](https://github.com/apache/servicecomb-service-center/blob/master/examples/infrastructures/docker) to deploy Service-Center with Grafana,
-and this is the [template](https://github.com/apache/servicecomb-service-center/blob/master/integration/health-metrics-grafana.json) file
-can be imported in Grafana.
-
-After the import, you can get the view like blow.
-
-```eval_rst
-.. image:: integration-grafana.PNG
-```
-
-Note: As the template has an ASF header, please remove the header first
-if you import this template file.
\ No newline at end of file
diff --git a/docs/user-guides/integration-grafana.rst b/docs/user-guides/integration-grafana.rst
new file mode 100644
index 0000000..0266d10
--- /dev/null
+++ b/docs/user-guides/integration-grafana.rst
@@ -0,0 +1,17 @@
+Integrate with Grafana
+======================
+
+As Service-Center uses Prometheus lib to report metrics. Then it is easy
+to integrate with Grafana. Here is a `DEMO`_ to deploy Service-Center
+with Grafana, and this is the `template`_ file can be imported in
+Grafana.
+
+After the import, you can get the view like blow.
+
+.. image:: integration-grafana.PNG
+
+Note: As the template has an ASF header, please remove the header first
+if you import this template file.
+
+.. _DEMO: https://github.com/apache/servicecomb-service-center/blob/master/examples/infrastructures/docker
+.. _template: https://github.com/apache/servicecomb-service-center/blob/master/integration/health-metrics-grafana.json
\ No newline at end of file