README
¶
Istio
An open platform to connect, manage, and secure microservices.
In addition, here are some other docs you may wish to read:
- Istio Community - describes how to get involved and contribute to the Istio project
- Istio Developer's Guide - explains how to setup and use an Istio development environment
- Project Conventions - describes the conventions we use within the code base
- Creating Fast and Lean Code - performance-oriented advice and guidelines for the code base
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, and Eureka-based environments. We plan support for additional platforms such as Cloud Foundry, and Mesos in the near future.
Repositories
The Istio project is divided across a few GitHub repositories.
-
istio/istio. This is the main repo that you are currently looking at. It hosts Istio's core components and also the sample programs and the various documents that govern the Istio open source project. It includes:
- security. This directory contains security related code, including CA (Cert Authority), node agent, etc.
- pilot. This directory 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 directory.
- mixer. This directory 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.
- broker. This directory contains code for Istio's implementation of the Open Service Broker API.
-
istio/api. This repository defines component-level APIs and common configuration formats for the Istio platform.
-
istio/mixerclient. Client libraries for Mixer's 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 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.
Directories
¶
| Path | Synopsis |
|---|---|
|
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/testing/mock/proto
Package proto is a generated protocol buffer package.
|
Package proto is a generated protocol buffer package. |
|
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. |
|
mixer
|
|
|
adapter/circonus/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/denier/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
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/kubernetes/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/list/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/memquota
Package memquota provides a simple in-memory quota implementation.
|
Package memquota provides a simple in-memory quota implementation. |
|
adapter/memquota/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
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. |
|
adapter/prometheus/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/stackdriver/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/statsd/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/stdio/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/svcctrl/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
adapter/svcctrl/template/svcctrlreport
Package svcctrlreport is a generated protocol buffer package.
|
Package svcctrlreport is a generated protocol buffer package. |
|
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/template
Package istio_mixer_v1_config_template is a generated protocol buffer package.
|
Package istio_mixer_v1_config_template is a generated protocol buffer package. |
|
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/config
Package config is a generated protocol buffer package.
|
Package config is a generated protocol buffer package. |
|
pkg/aspect/test
Package test provides utilities for testing the //pkg/aspect code.
|
Package test provides utilities for testing the //pkg/aspect code. |
|
pkg/cache
Package cache provides general-purpose in-memory caches.
|
Package cache provides general-purpose in-memory caches. |
|
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/proto
Package istio_mixer_v1_config is a generated protocol buffer package.
|
Package istio_mixer_v1_config is a generated protocol buffer package. |
|
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/log
Package log provides the canonical logging functionality used by Go-based Istio components.
|
Package log provides the canonical logging functionality used by Go-based Istio components. |
|
pkg/mockapi
Package mockapi supplies a fake Mixer server for use in testing.
|
Package mockapi supplies a fake Mixer server for use in testing. |
|
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/tracing
Package tracing provides utilities for creating a tracer to use within Mixer commands (mixc, mixs).
|
Package tracing provides utilities for creating a tracer to use within Mixer commands (mixc, mixs). |
|
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. |
|
template/apikey
Package apikey is a generated protocol buffer package.
|
Package apikey is a generated protocol buffer package. |
|
template/authorization
Package authorization is a generated protocol buffer package.
|
Package authorization is a generated protocol buffer package. |
|
template/checknothing
Package checknothing is a generated protocol buffer package.
|
Package checknothing is a generated protocol buffer package. |
|
template/listentry
Package listentry is a generated protocol buffer package.
|
Package listentry is a generated protocol buffer package. |
|
template/logentry
Package logentry is a generated protocol buffer package.
|
Package logentry is a generated protocol buffer package. |
|
template/metric
Package metric is a generated protocol buffer package.
|
Package metric is a generated protocol buffer package. |
|
template/quota
Package quota is a generated protocol buffer package.
|
Package quota is a generated protocol buffer package. |
|
template/reportnothing
Package reportnothing is a generated protocol buffer package.
|
Package reportnothing is a generated protocol buffer package. |
|
template/sample/apa
Package istio_mixer_adapter_sample_myapa is a generated protocol buffer package.
|
Package istio_mixer_adapter_sample_myapa is a generated protocol buffer package. |
|
template/sample/check
Package istio_mixer_adapter_sample_check is a generated protocol buffer package.
|
Package istio_mixer_adapter_sample_check is a generated protocol buffer package. |
|
template/sample/quota
Package istio_mixer_adapter_sample_quota is a generated protocol buffer package.
|
Package istio_mixer_adapter_sample_quota is a generated protocol buffer package. |
|
template/sample/report
Package istio_mixer_adapter_sample_report is a generated protocol buffer package.
|
Package istio_mixer_adapter_sample_report is a generated protocol buffer package. |
|
template/tracespan
Package tracespan is a generated protocol buffer package.
|
Package tracespan is a generated protocol buffer package. |
|
test/spyAdapter/template/report
Package samplereport is a generated protocol buffer package.
|
Package samplereport is a generated protocol buffer package. |
|
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 |
|
test/grpcecho
Package grpecho is a generated protocol buffer package.
|
Package grpecho is a generated protocol buffer package. |
|
tools/version
Package version provides build time version information.
|
Package version provides build time version information. |
|
security
|
|
|
proto
Package istio_v1_auth is a generated protocol buffer package.
|
Package istio_v1_auth is a generated protocol buffer package. |
|
tests
|
|
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.