-
Notifications
You must be signed in to change notification settings - Fork 107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added basic analysis and introduction to TARS in README.md added a License.md #237
Open
MOJO-007
wants to merge
4
commits into
sodafoundation:master
Choose a base branch
from
MOJO-007:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1a4f93b
Modified the readme.md file to contain basic introduction,added Licen…
MOJO-007 522b736
README.md basic layout done.
MOJO-007 b5300b6
Added architecture diagram and changed file name
MOJO-007 c9f22c1
made changes to analysis file accoring to previous comments
MOJO-007 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
BSD 3-Clause License | ||
|
||
Copyright (c) 2020, THE TARS FOUNDATION | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of the copyright holder nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,87 @@ | ||
# All the uncategorized / general technical analysis go here. | ||
|
||
## Basic Layout Suggestion for your Analysis: | ||
- Topic Introduction | ||
- [Project/Topic basic information, links, etc] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please give a proper file name - Not "README.md" (like tars-cloud-basic-analysis) |
||
- Purpose | ||
- Technical Analysis | ||
- Recommendation/Suggestions | ||
## TARS - Focus on Microservice Ecosystem | ||
|
||
## Introduction | ||
Tars is a open-source microservice platform. It contains a high-performance RPC framework and a service management platform. Based on Tars, you can develop a reliable microservice system efficiently. | ||
|
||
Tars is an open-source version of TAF which has being used in Tencent for years. The name, Tars, comes from the robot in the movie Interstellar. In the movie, Tars has a friendly interactive mode - everyone who first meets him can interact with him easily. The robot Tars can accomplish missions efficiently, even under hard conditions. | ||
|
||
The open-source project Tars carries the same mission as robot Tars does. It is designed for high reliability, high performance, and efficient service management. By significantly reducing system operation work, developers can focus on business logic and meet fast changes of user requirements. | ||
|
||
Right now, thousands of services in Tencent have been developed with TAF, running on tens of thousands of machines | ||
## | ||
Tars comes from the robot in Interstellar movie. Tars is a high-performance RPC framework based on name service and Tars protocol, also integrated administration platform, and implemented hosting-service via flexible schedule. | ||
|
||
Tars, aka TAF(Total Application Framework), has been used in Tencent since 2008. It supports C++,Java,Nodejs and php for now. This framework offers a set of solution for development, maintenance and testing, which making develop, deploy and testing service efficiently. It integrated extensible protocol for encoding/decoding, high-performance RPC communication framework, name service, monitor, statistics and configuration. You can use it to develop your reliable distributed application based on microservice fast, and reach fully efficient service management. | ||
|
||
Nowadays it’s used by hundreds of bussiness in Tencent, services that developed base on TAF run on 16 thousands of machines. | ||
|
||
## TARS Features: | ||
- Protocol | ||
- TARS protocol is an implementation for IDL language. It is binary, extensible and cross-platform. <br>Thus, servant objects implemented in different languages can communicate with each other through RPC calls. | ||
- Trace | ||
- The framework can trace a specific request of a service. the traced request is labeled and forwarded to server. <br>Then, servers report logs for traced request to log server. Users can analysis logs for traced request and diagnose problems. | ||
- Monitor | ||
- The framework supports following data report function in order to monitor the quality of service process and business running status. | ||
- DEV-MODE | ||
- Developers define service interface via IDL. Tars generates codes for communication between client and server. <br>Service only needs to implement service logic and client uses the generated code to call the service. The invoke modes split to 3 kinds: sync, async and one-way request. | ||
- Balance | ||
- The framework uses name service for service register and discovery. Client gets server address list via name service, then it uses a specified load balance policy to call servers.<br>The supported load balance policies are round-robin, hash, weighted policy. | ||
- GROUP | ||
- In order to reduce response time of calls among servers and minimize influence of network failure, tars supports IDC grouping to groups server according to their locations.<br> To facilitate service management, tars groups servers into Sets. | ||
- CONFIG | ||
- Server configurations are managed by tarsweb. Developer can change configurations in a webpage making the change easily and the change is safer. <br> Developer can check history of configuration changes and rollback to previous version. | ||
- SHIELD | ||
- It's implemented with two ways: name service excluded and client shielding. <br>Name service will exclude fail server from address list. And Client removes inactive server from the server list for client shielding. | ||
- PROTECT | ||
- To avoid overloading the system because of burst requests or machine fault, tars handles this scenario in the framework. In order to improve system throughput, server uses request queue to process request asynchronously. | ||
|
||
|
||
|
||
|
||
## Supported Platforms : | ||
- Linux | ||
- Windows | ||
- MAC | ||
|
||
## Supported Languages : | ||
- C++ | ||
- Java | ||
- Nodejs | ||
- PHP | ||
- Go | ||
|
||
## TARS Projects : | ||
- TARS LAB | ||
- JMeter | ||
- Benchmark | ||
- TarsJavaStart | ||
- TarsTools | ||
- Service Governance | ||
- Tseer | ||
- Gateway | ||
- Storage | ||
- DCache | ||
- Infrastructure | ||
- K8Stars | ||
|
||
### Link for TARS Landscape: https://tarscloud.org/foundation/projects | ||
|
||
# Technical Analysis: | ||
Add Technical Analysis here. | ||
|
||
## Other Links: | ||
| -- | TARS | | ||
|--|--| | ||
| **Website** | https://tarscloud.org/ | | ||
| **TARS Projects** | https://tarscloud.org/foundation/projects| | ||
| **License** | [BSD-3-Clause](License.md) | | ||
| **TARS Projects** | https://github.com/TarsCloud | | ||
| **Twitter** | https://twitter.com/TarsCloud | | ||
|
||
## Contributing: | ||
Contributing | ||
MOJO-007 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
If you meet any problems never found in historical issues, please submit one! | ||
|
||
If you find any bugs or get any new ideas, please submit PR! | ||
|
||
**NOTE: Before you submit PR, please check whether you signed CLA!!** |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is not needed under GeneralTopics/ It gives a different meaning. If you want to mention the license of tars, you can mention in the analysis document itself