-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CONSUL-417] Update Docs Single Container (#51)
- Loading branch information
Showing
2 changed files
with
61 additions
and
131 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,61 @@ | ||
| # Single Container Test Architecture | ||
|
|
||
| ## Index | ||
|
|
||
| - [About](#about) | ||
| - [Docker Image Components](#docker-image-components) | ||
| - Main Components: | ||
| - [Bats](#bats) | ||
| - [Fortio](#fortio) | ||
| - [Jaegertracing](#jaegertracing) | ||
| - [Openzipkin](#openzipkin) | ||
| - Additional tools: | ||
| - [JQ](#jq) | ||
| - [Openssl](#openssl) | ||
| - [Git Bash](#git-bash) | ||
|
|
||
| ## About | ||
|
|
||
| The purpose of this document is to describe how the Single Container test architecture is composed. | ||
|
|
||
| ## Docker Image Components | ||
|
|
||
| The Docker image used for the Consul - Envoy integration tests has several components needed to run those tests. | ||
|
|
||
| - Main Components: | ||
| - [Bats](#bats) | ||
| - [Fortio](#fortio) | ||
| - [Jaegertracing](#jaegertracing) | ||
| - [Openzipkin](#openzipkin) | ||
| - Additional tools: | ||
| - [JQ](#jq) | ||
| - [Openssl](#openssl) | ||
| - [Git Bash](#git-bash) | ||
|
|
||
| ### Bats | ||
|
|
||
| BATS stands for Bash Automated Testing System and is the one in charge of executing the tests. | ||
|
|
||
| ### Fortio | ||
|
|
||
| Fortio is a microservices (http, grpc) load testing library, command line tool, advanced echo server, and web UI. It is used to run the services registered into Consul during the integration tests. | ||
|
|
||
| ### Jaegertracing | ||
|
|
||
| Jaeger is open source software for tracing transactions between distributed services. It's used for monitoring and troubleshooting complex microservices environments. It is used along with Openzipkin in some test cases. | ||
|
|
||
| ### Openzipkin | ||
|
|
||
| Zipkin is also a tracing software. | ||
|
|
||
| ### JQ | ||
|
|
||
| Jq is a lightweight and flexible command-line JSON processor. It is used in several tests to modify and filter JSON outputs. | ||
|
|
||
| ### Openssl | ||
|
|
||
| Open SSL is an all-around cryptography library that offers open-source application of the TLS protocol. It is used to verify that the correct tls certificates are being provisioned during tests. | ||
|
|
||
| ### Git Bash | ||
|
|
||
| This tool is only used in Windows tests, it was added to the Docker image to be able to use some Linux commands during test execution. |