Skip to content

Commit fcfc1c4

Browse files
author
Martin Taillefer
committed
Break up what-is-istio doc into three distinct docs.
1 parent 23f773b commit fcfc1c4

File tree

7 files changed

+213
-163
lines changed

7 files changed

+213
-163
lines changed

_includes/doc-side-concepts-nav.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
<ul class="doc-side-nav doc-side-nav-concepts">
22
{% assign current = page.url | downcase | split: '/' %}
33
<li><h5 class="doc-side-nav-title">Concepts</h5></li>
4-
<li class="doc-side-nav-list-item"><a href="{{ site.baseurl }}/docs/concepts/what-is-istio.html" {% if current[3] == 'what-is-istio.html' %}class='current'{% endif %}>What is Istio?</a></li>
4+
<li class="submenu">
5+
<h6 class="arrow-r">What is Istio?</h6>
6+
<div class="submenu-content">
7+
<a class="submenu-link {% if current[3] == 'context-and-overview.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/context-and-overview.html">Context and Overview</a>
8+
<a class="submenu-link {% if current[3] == 'design-goals.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/design-goals.html">Design Goals</a>
9+
<a class="submenu-link {% if current[3] == 'high-level-architecture.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/high-level-architecture.html">High-Level Architecture</a>
10+
</div>
11+
</li>
12+
513
<li class="doc-side-nav-list-item"><a href="{{ site.baseurl }}/docs/concepts/service-model.html" {% if current[3] == 'service-model.html' %}class='current'{% endif %}>Service Model</a></li>
614

715
<li class="submenu">
@@ -11,7 +19,7 @@ <h6 class="arrow-r">Network and Auth</h6>
1119
<li class="submenu">
1220
<h6 class="arrow-r">Policies and Control</h6>
1321
<div class="submenu-content">
14-
<a class="submenu-link {% if current[3] == 'attribute.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/attributes.html">Attributes</a>
22+
<a class="submenu-link {% if current[3] == 'attributes.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/attributes.html">Attributes</a>
1523
<a class="submenu-link {% if current[3] == 'mixer.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/mixer.html">Mixer</a>
1624
<a class="submenu-link {% if current[3] == 'mixer-config.html' %}active{% endif %}" href="{{ site.baseurl }}/docs/concepts/mixer-config.html">Mixer Configuration</a>
1725
</div>

_sass/modules/_doc-nav.scss

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@
6666

6767
// Documentation Side Navigation
6868
.doc-side-nav {
69-
//background-color: $light-gray;
7069
margin-bottom: 20px;
7170

7271
@media (min-width: $tablet) {
@@ -76,7 +75,7 @@
7675

7776
// Add caret to current page
7877
.current:before{
79-
//content: '> ';
78+
content: '> '
8079
background-color: $gray;
8180
}
8281

@@ -91,15 +90,12 @@
9190
width: 100%;
9291

9392
a {
94-
//font-size: 13px;
95-
//color: $dark-gray;
9693
font-weight: 400;
9794
}
98-
9995
}
10096

10197
h6 {
102-
color: $mainBrandColor; //$dark-gray;
98+
color: $mainBrandColor;
10399
font-size: 100%; // hack
104100
font-weight: 400;
105101
line-height: 22px;
@@ -114,7 +110,7 @@
114110
font-size: 100%;
115111
font-weight: 400;
116112
line-height: 22px;
117-
color: $mainBrandColor; //$gray;
113+
color: $mainBrandColor;
118114

119115
&.active:before {
120116
margin-left: -0.80em;

docs/concepts/context-and-overview.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Concepts and Overview
3+
headline: Concepts and Overview
4+
sidenav: doc-side-concepts-nav.html
5+
bodyclass: docs
6+
layout: docs
7+
type: markdown
8+
---
9+
10+
{% capture overview %}
11+
This page introduces Istio, a polyglot service mesh.
12+
{% endcapture %}
13+
14+
{% capture body %}
15+
16+
## Context and overview
17+
18+
As monolithic applications transition towards a distributed microservice architecture they become more difficult to manage and understand. These
19+
architectures need basic necessities such as discovery, load balancing, failure recovery, metrics and monitoring, and more complex operational requirements
20+
such as A/B testing, canary releases, rate limiting, access control, and end-to-end authentication. The term service mesh is used to describe the network of
21+
microservices that make up applications and the interactions between them. As the service mesh grows in size and complexity, it becomes harder to understand
22+
and manage.
23+
24+
Istio provides a complete solution to satisfying these diverse requirements of microservice applications, by providing developers and operators with
25+
behavioral insights and operational control over the service mesh as a whole. Istio does this by providing a number of key capabilities uniformly across the
26+
network of services:
27+
28+
- **Traffic Management**. Control the flow of traffic and API calls between services, make calls more reliable and make the network more robust in the face
29+
of adverse conditions.
30+
31+
- **Observability**. Gain understanding of the dependencies between services, the nature and flow of traffic between them and be able to quickly identify
32+
issues.
33+
34+
- **Policy Enforcement**. Apply organizational policy to the interaction between services, ensure access policies are enforced and resources are fairly
35+
distributed among consumers. Policy changes are made by configuring the mesh, not by changing application code.
36+
37+
- **Service Identity and Security**. Provide services in the mesh with a verifiable identity and provide the ability to protect service traffic
38+
as it flows over networks of varying degrees of trustability.
39+
40+
In addition to these behaviors, Istio is designed for extensibility to meet diverse deployment needs:
41+
42+
- **Platform Support**. Istio is designed to run in a variety of environments including ones that span Cloud, on-premise, Kubernetes, Mesos etc. We’re
43+
initially focused on Kubernetes but are working to support other environments soon.
44+
45+
- **Integration and Customization**. The policy enforcement component can be extended and customized to integrate with existing solutions for
46+
ACLs, logging, monitoring, quotas, auditing and more.
47+
48+
These capabilities greatly decrease the coupling between application code, the underlying platform and policy. This decreased coupling not only makes
49+
services easier to implement but also makes it simpler for operators to move application deployments between environments or to new policy schemes.
50+
Applications become inherently more portable as a result.
51+
52+
Istio’s service mesh is logically split into a *data plane* and a *control plane*. The data plane is composed of a set of intelligent (HTTP, HTTP/2, gRPC, TCP or UDP)
53+
proxies deployed as sidecars that mediate and control all network communication between microservices. The control plane is responsible for managing and
54+
configuring proxies to route traffic, as well as enforce policies at runtime.
55+
56+
57+
{% endcapture %}
58+
59+
{% include templates/concept.md %}

docs/concepts/design-goals.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Design Goals
3+
headline: Design Goals
4+
sidenav: doc-side-concepts-nav.html
5+
bodyclass: docs
6+
layout: docs
7+
type: markdown
8+
---
9+
10+
{% capture overview %}
11+
This page the core principles that guide Istio's design
12+
{% endcapture %}
13+
14+
{% capture body %}
15+
16+
## Design goals
17+
18+
Istio’s architecture is informed by a few key design goals that are essential to making the system capable of dealing with services at scale and with high
19+
performance.
20+
21+
- **Maximize Transparency**.
22+
To adopt Istio an operator or developer should be required to do the minimum amount of work possible to get real value from the system. To this end Istio
23+
can automatically inject itself into all the network paths between services. Istio uses sidecar proxies to capture traffic and where possible automatically
24+
program the networking layer to route traffic through those proxies without any changes to the deployed application code. In Kubernetes the proxies are
25+
injected into pods and traffic is captured by programming iptables rules. Once the sidecar proxies are injected and traffic routing is programmed Istio is
26+
able to mediate all traffic. This principle also applies to performance. When applying Istio to a deployment operators should see a minimal increase in
27+
resource costs for the
28+
functionality being provided. Components and APIs must all be designed with performance and scale in mind.
29+
30+
- **Incrementality**.
31+
As operators and developers become more dependent on the functionality that Istio provides, the system must grow with their needs. While we expect to
32+
continue adding new features ourselves, we expect the greatest need will be the ability to extend the policy system, to integrate with other sources of policy and control and to propagate signals about mesh behavior to other systems for analysis. The policy runtime supports a standard extension mechanism for plugging in other services. In addition it allows for the extension of its vocabulary to allow policies to be enforced based on new signals that the mesh produces.
33+
34+
- **Portability**.
35+
The ecosystem in which Istio will be used varies along many dimensions. Istio must run on any cloud or on-prem environment with minimal effort. The task of
36+
porting Istio-based services to new environments should be trivial, and it should be possible to operate a single service deployed into multiple
37+
environments (on multiple clouds for redundancy for example) using Istio.
38+
39+
- **Policy Uniformity**.
40+
The application of policy to API calls between services provides a great deal of control over mesh behavior but it can be equally important to apply
41+
policies to resources which are not necessarily expressed at the API level. For example applying quota to the amount of CPU consumed by an ML training task
42+
is more useful than applying quota to the call which initiated the work. To this end the policy system is maintained as a distinct service with its own API
43+
rather than being baked into the proxy/sidecar, allowing services to directly integrate with it as needed.
44+
45+
{% endcapture %}
46+
47+
{% include templates/concept.md %}
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: What is Istio?
3+
headline: What is Istio?
4+
sidenav: doc-side-concepts-nav.html
5+
bodyclass: docs
6+
layout: docs
7+
type: markdown
8+
---
9+
10+
{% capture overview %}
11+
This page presents an architectural overview for the Istio service mesh.
12+
{% endcapture %}
13+
14+
{% capture body %}
15+
16+
## High-level architecture
17+
18+
<img src="./arch.svg" alt="The overall architecture of an Istio-based application." />
19+
20+
### The sidecar model
21+
22+
As monolithic applications are decomposed into a distributed system of microservices that scale dynamically, classic distributed system problems such as
23+
service discovery, load balancing, and failure recovery become increasingly import to solve uniformly. As the application gains more agility, it transitions
24+
towards a process wherein updates are made to different parts of the application at different times. Developers need the ability to experiment with
25+
different features in production, or deploy canary releases, without impacting the system as a whole. Operators need to enforce organization-wide policies,
26+
such as global rate limits, ACLs, etc., without requiring updates to each microservice.
27+
28+
Today, these problems are tackled piecemeal within the industry. Language-specific libraries, such as Ribbon/Hystrix from Netflix’s OSS stack, are used to
29+
satisfy basic necessities such as discovery, load balancing and circuit breaking. In a polyglot application, organizations need to maintain
30+
language-specific libraries for every language being used, dramatically increasing the maintenance cost.
31+
32+
A host of API management tools are typically bolted onto the edge of the infrastructure to provide subscription, metering, API metrics monitoring, rate
33+
limiting, etc. Continuous delivery and experimentation of new features in production is restricted to edge services using an edge proxy (e.g., Zuul/Nginx).
34+
Policy enforcement between mid-tier services is difficult or impossible as libraries provide little control over how traffic flows between microservices.
35+
36+
Compared to using language-specific libraries, the out-of-process transparent proxy approach has a much lower maintenance overhead. A single proxy
37+
implementation can be shared across all services in an organization. This single implementation can be optimized for performance while providing a variety
38+
of functions beneficial to all services in the application. It eliminates the need for applications to be rebuilt whenever new functionality is available.
39+
Support for continuous delivery, policy enforcement, and in-depth monitoring of service health can be engineered into the proxy and leveraged across
40+
different services (edge & middle-tier) with minimal effort on behalf of the application developer. As the proxy can act as both an edge proxy as well as a
41+
middle-tier router, middle-tier services can also take advantage of the continuous delivery and policy enforcement features provided. By offloading all
42+
aspects of communication, failure recovery, and policy enforcement to the proxy, the application logic is dramatically simplified.
43+
44+
### Envoy
45+
46+
Istio uses the Envoy proxy, a high-performance proxy developed in C++, to mediate all inbound and outbound traffic for all services in the service mesh.
47+
Istio leverages Envoy’s many built-in features such as dynamic service discovery, load balancing, TLS termination, HTTP/2 & gRPC proxying, circuit breakers,
48+
health checks, staged rollouts with %-based traffic split, fault injection, and rich metrics. In addition, Istio extends Envoy to interact with Mixer to
49+
enable policy enforcement and to report telemetry.
50+
51+
### Mixer
52+
53+
Mixer is responsible for enforcing access control and usage policies across the service mesh and collects telemetry data from the Envoy proxy and other
54+
services. The proxy extracts request level attributes which are sent to Mixer for evaluation. More information on the attribute extraction and policy
55+
evaluation can be found here. Mixer includes a flexible plugin model enabling it to interface with a variety of host environments and backends, abstracting
56+
the Envoy proxy and Istio-managed services from these details.
57+
58+
### Istio-Manager
59+
60+
Istio-Manager serves as an interface between the user and Istio, collecting and validating configuration and propagating it to the various Istio components.
61+
It abstracts environment-specific implementation details from the Mixer and Envoy, providing them with an abstract representation of the user’s services
62+
that is independent of the underlying platform. In addition, traffic management rules (i.e. generic layer-4 rules and layer-7 HTTP/gRPC routing rules) can
63+
be programmed at runtime via Istio-Manager.
64+
65+
### Istio-Auth
66+
67+
Istio-Auth provides strong service-to-service and end-user authentication using mutual TLS, with built-in identity and credential management.
68+
It can be used to upgrade unencrypted traffic in the service mesh, and provides operators the ability to enforce policy based
69+
on service identity rather than network controls. Future releases of Istio will add fine-grained access control and auditing to control
70+
and monitor who accesses your service, API, or resource, using a variety of access control mechanisms, including attribute and
71+
role-based access control as well as authorization hooks.
72+
73+
{% endcapture %}
74+
75+
{% include templates/concept.md %}

docs/concepts/index.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,28 @@ type: markdown
1212
Concepts help you learn about the different parts
1313
of the Istio system and the abstractions it uses.
1414

15-
- [What is Istio?](./what-is-istio.html). Provides a broad overview of what
16-
problems Istio is designed to solve as well as presenting its high-level
17-
architecture,
15+
- What Is Istio?
16+
17+
- [Context and Overview](./context-and-overview). Provides a broad overview of what
18+
problems Istio is designed to solve.
19+
20+
- [Design Goals](./design-goals.html). Describes the core principles that
21+
Istio's design adheres to.
22+
23+
- [High-Level Architecture](./high-level-architecture.html). Highlights Istio's core
24+
architectural structure and components.
1825

1926
- [Service Model](./service-model.html). Describes how services are modeled
2027
within the Istio mesh.
2128

22-
- [Attributes](./attributes.html). Explains the important notion of attributes, which
23-
is a central mechanism for how policies and control are applied to services within the
24-
mesh.
29+
- Policies and Control
30+
31+
- [Attributes](./attributes.html). Explains the important notion of attributes, which
32+
is a central mechanism for how policies and control are applied to services within the
33+
mesh.
2534

26-
- [Mixer](./mixer.html). Architectural deep-dive into the design of Mixer, which provides
27-
the policy and control mechanisms within the service mesh.
35+
- [Mixer](./mixer.html). Architectural deep-dive into the design of Mixer, which provides
36+
the policy and control mechanisms within the service mesh.
2837

29-
- [Mixer Configuration](./mixer-config.html). An overview of the key concepts used to configure
30-
Mixer.
38+
- [Mixer Configuration](./mixer-config.html). An overview of the key concepts used to configure
39+
Mixer.

0 commit comments

Comments
 (0)