README
¶
Istio
An open platform to connect, manage, and secure microservices.
- Introduction
- Istio authors
- Repositories
- Issue management
- Contributing to the project
- Community and support
Introduction
Istio is an open platform for providing a uniform way to integrate microservices, manage traffic flow across microservices, enforce policies and aggregate telemetry data. Istio's control plane provides an abstraction layer over the underlying cluster management platform, such as Kubernetes, Mesos, etc.
Visit istio.io for in-depth information about using Istio.
Istio is composed of these components:
-
Envoy - Sidecar proxies per microservice to handle ingress/egress traffic between services in the cluster and from a service to external services. The proxies form a secure microservice mesh providing a rich set of functions like discovery, rich layer-7 routing, circuit breakers, policy enforcement and telemetry recording/reporting functions.
Note: The service mesh is not an overlay network. It simplifies and enhances how microservices in an application talk to each other over the network provided by the underlying platform.
-
Mixer - Central component that is leveraged by the proxies and microservices to enforce policies such as ACLs, rate limits, quotas, authentication, request tracing and telemetry collection.
-
Pilot - A component responsible for configuring the proxies at runtime.
-
CA - A component responsible for cert issuance and rotation.
-
Broker - A component implementing the open service broker API for Istio-based services. (Under development)
Istio currently supports Kubernetes, Consul, Eureka-based environments. We plan support for additional platforms such as Cloud Foundry, and Mesos in the near future.
Istio authors
Istio is an open source project with an active development community. The project was started by teams from Google and IBM, in partnership with the Envoy team at Lyft.
Repositories
The Istio project is divided across multiple GitHub repositories. Each repository contains information about how to build and test it.
-
istio/api. This repository defines component-level APIs and common configuration formats for the Istio platform.
-
istio/auth. This repository contains auth related code, including CA (Cert Authority), node agent, etc.
-
istio/istio. This is the repo you are currently looking at. It hosts the various Istio sample programs along with the various documents that govern the Istio open source project.
-
istio/pilot. This repository contains platform-specific code to populate the abstract service model, dynamically reconfigure the proxies when the application topology changes, as well as translate routing rules into proxy specific configuration. The istioctl command line utility is also available in this repository.
-
istio/mixer. This repository contains code to enforce various policies for traffic passing through the proxies, and collect telemetry data from proxies and services. There are plugins for interfacing with various cloud platforms, policy management services, and monitoring services.
-
istio/mixerclient. Client libraries for the mixer API.
-
istio/broker. This repository contains code for Istio's implementation of the Open Service Broker API.
-
istio/proxy. The Istio proxy contains extensions to the Envoy proxy (in the form of Envoy filters), that allow the proxy to delegate policy enforcement decisions to the mixer.
Issue management
We use GitHub combined with ZenHub to track all of our bugs and feature requests. Each issue we track has a variety of metadata:
-
Epic. An epic represents a feature area for Istio as a whole. Epics are fairly broad in scope and are basically product-level things. Each issue is ultimately part of an epic.
-
Milestone. Each issue is assigned a milestone. This is 0.1, 0.2, 0.3, or 'Nebulous Future'. The milestone indicates when we think the issue should get addressed.
-
Priority/Pipeline. Each issue has a priority which is represented by the Pipeline field within GitHub. Priority can be one of P0, P1, P2, or >P2. The priority indicates how important it is to address the issue within the milestone. P0 says that the milestone cannot be considered achieved if the issue isn't resolved.
We don't annotate issues with Releases; Milestones are used instead. We don't use GitHub projects at all, that support is disabled for our organization.
Contributing to the project
We promote and encourage a set of shared values to improve our productivity and inter-personal interactions.
See the working groups for a list of working groups to participate in.
See the contribution guidelines for information on how to participate in the Istio project by submitting pull requests or issues.
You can then check out how to setup for development.
Community and support
There are several communication channels available to get support for Istio or to participate in its evolution.
Directories
¶
| Path | Synopsis |
|---|---|
|
auth
|
|
|
broker
|
|
|
cmd/brkcol/cmd
Package cmd provides a simple command to be used to output the auto-generated collateral files for the various broker CLI commands.
|
Package cmd provides a simple command to be used to output the auto-generated collateral files for the various broker CLI commands. |
|
cmd/shared
Package shared contains types and functions that are used across the full set of broker commands.
|
Package shared contains types and functions that are used across the full set of broker commands. |
|
pkg/controller
Package controller contains the actual processing of frontend requests.
|
Package controller contains the actual processing of frontend requests. |
|
pkg/platform/kube/crd
Package crd provides an implementation of the config store and cache using Kubernetes Custom Resources and the informer framework from Kubernetes This implementation is adopted from github.com/istio/pilot/adapter/config/crd/
|
Package crd provides an implementation of the config store and cache using Kubernetes Custom Resources and the informer framework from Kubernetes This implementation is adopted from github.com/istio/pilot/adapter/config/crd/ |
|
pkg/server
Package server provides HTTP open service broker API server bindings.
|
Package server provides HTTP open service broker API server bindings. |
|
pkg/version
Package version provides utilities for reporting build information (including version, build id, and status) for broker.
|
Package version provides utilities for reporting build information (including version, build id, and status) for broker. |
|
devel
|
|
|
mixer
|
|
|
adapter/kubernetes
Package kubernetes provides functionality to adapt mixer behavior to the kubernetes environment.
|
Package kubernetes provides functionality to adapt mixer behavior to the kubernetes environment. |
|
adapter/memquota
Package memquota provides a simple in-memory quota implementation.
|
Package memquota provides a simple in-memory quota implementation. |
|
adapter/noopLegacy
Package noopLegacy is an empty adapter implementing every aspect.
|
Package noopLegacy is an empty adapter implementing every aspect. |
|
adapter/prometheus
Package prometheus publishes metric values collected by Mixer for ingestion by prometheus.
|
Package prometheus publishes metric values collected by Mixer for ingestion by prometheus. |
|
cmd/shared
Package shared contains types and functions that are used across the full set of mixer commands.
|
Package shared contains types and functions that are used across the full set of mixer commands. |
|
example/servicegraph
Package servicegraph defines the core model for the servicegraph service.
|
Package servicegraph defines the core model for the servicegraph service. |
|
example/servicegraph/dot
Package dot provides serialization utilities for a servicegraph using the dot format.
|
Package dot provides serialization utilities for a servicegraph using the dot format. |
|
example/servicegraph/promgen
Package promgen generates service graphs from a prometheus backend.
|
Package promgen generates service graphs from a prometheus backend. |
|
pkg/adapter
Package adapter defines the types consumed by adapter implementations to interface with Mixer.
|
Package adapter defines the types consumed by adapter implementations to interface with Mixer. |
|
pkg/adapter/test
Package test provides utility functions to assist in creating quality tests for adapters.
|
Package test provides utility functions to assist in creating quality tests for adapters. |
|
pkg/aspect
Package aspect contains the various aspect managers which are responsible for mapping incoming requests into the interface expected by individual types of aspects.
|
Package aspect contains the various aspect managers which are responsible for mapping incoming requests into the interface expected by individual types of aspects. |
|
pkg/aspect/test
Package test provides utilities for testing the //pkg/aspect code.
|
Package test provides utilities for testing the //pkg/aspect code. |
|
pkg/config
Package config handles configuration ingestion and processing.
|
Package config handles configuration ingestion and processing. |
|
pkg/config/crd
Package crd provides the store interface to config resources stored as kubernetes custom resource definitions (CRDs).
|
Package crd provides the store interface to config resources stored as kubernetes custom resource definitions (CRDs). |
|
pkg/config/store
Package store provides the interface to the backend storage for the config and the default fsstore implementation.
|
Package store provides the interface to the backend storage for the config and the default fsstore implementation. |
|
pkg/il
Package il implements the intermediate-language for the config-language interpreter of Mixer.
|
Package il implements the intermediate-language for the config-language interpreter of Mixer. |
|
pkg/il/compiler
Package compiler implements a compiler that converts Mixer's expression language into a Mixer IL-based program that can be executed via an interpreter.
|
Package compiler implements a compiler that converts Mixer's expression language into a Mixer IL-based program that can be executed via an interpreter. |
|
pkg/il/interpreter
Package interpreter implements an interpreter based runtime for the Mixer IL.
|
Package interpreter implements an interpreter based runtime for the Mixer IL. |
|
pkg/pool
Package pool provides access to a mixer-global pool of buffers, a pool of goroutines, and a string interning table.
|
Package pool provides access to a mixer-global pool of buffers, a pool of goroutines, and a string interning table. |
|
pkg/status
Package status provides utility functions for RPC status objects.
|
Package status provides utility functions for RPC status objects. |
|
pkg/version
Package version provides utilities for reporting build information (including version, build id, and status) for mixer.
|
Package version provides utilities for reporting build information (including version, build id, and status) for mixer. |
|
test
Package test supplies a fake Mixer server for use in testing.
|
Package test supplies a fake Mixer server for use in testing. |
|
tools/codegen/pkg/inventory
Package inventory is used to generate the mixer adapter inventory source file.
|
Package inventory is used to generate the mixer adapter inventory source file. |
|
pilot
|
|
|
adapter/config/aggregate
Package aggregate implements a type-aggregator for config stores.
|
Package aggregate implements a type-aggregator for config stores. |
|
adapter/config/crd
Package crd provides an implementation of the config store and cache using Kubernetes Custom Resources and the informer framework from Kubernetes
|
Package crd provides an implementation of the config store and cache using Kubernetes Custom Resources and the informer framework from Kubernetes |
|
adapter/config/ingress
Package ingress provides a read-only view of Kubernetes ingress resources as an ingress rule configuration type store
|
Package ingress provides a read-only view of Kubernetes ingress resources as an ingress rule configuration type store |
|
adapter/config/memory
Package memory provides an in-memory volatile config store implementation
|
Package memory provides an in-memory volatile config store implementation |
|
model/test
Package test is a generated protocol buffer package.
|
Package test is a generated protocol buffer package. |
|
platform/kube
Package kube implements the shared and reusable library for Kubernetes
|
Package kube implements the shared and reusable library for Kubernetes |
|
tools/version
Package version provides build time version information.
|
Package version provides build time version information. |
|
tests
|
|