diff --git a/_docs/concepts/network-and-auth/auth.md b/_docs/concepts/network-and-auth/auth.md index e3f348939d..516ea799a2 100644 --- a/_docs/concepts/network-and-auth/auth.md +++ b/_docs/concepts/network-and-auth/auth.md @@ -88,7 +88,7 @@ Istio Auth workflow consists of two phases, deployment and runtime. This section 1. Istio CA watches Kubernetes API Server, creates a key and certificate pair for each of the existing and new service accounts, and sends them to API Server. -1. When a pod is created, API Server mounts the key and certificate pair according to the service account using [kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/). +1. When a pod is created, API Server mounts the key and certificate pair according to the service account using [Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/). 1. [Istio Manager](docs/concepts/traffic-management/manager.html) generates the config with proper key and certificate and secure naming information, which defines what service account(s) can run a certain service, and passes it to Envoy. diff --git a/_docs/concepts/policy-and-control/attributes.md b/_docs/concepts/policy-and-control/attributes.md index 140ede2d28..f8de2fca68 100644 --- a/_docs/concepts/policy-and-control/attributes.md +++ b/_docs/concepts/policy-and-control/attributes.md @@ -7,12 +7,10 @@ order: 10 layout: docs type: markdown --- +{% include home.html %} The page describes Istio attributes, what they are and how they are used. - - - ## Background Istio uses *attributes* to control the runtime behavior of services running in the mesh. Attributes are named and typed pieces of metadata @@ -31,7 +29,7 @@ determined by the set of attribute producers being used in the deployment. The p is Envoy, although specialized Mixer adapters and services can also introduce attributes. The common baseline set of attributes available in most Istio deployments is defined -[here](/docs/reference/api/attribute-vocabulary.html). +[here]({{home}}/docs/reference/api/attribute-vocabulary.html). diff --git a/_docs/concepts/policy-and-control/mixer-config.md b/_docs/concepts/policy-and-control/mixer-config.md index 4bd11b2cd8..72e56dbc0b 100644 --- a/_docs/concepts/policy-and-control/mixer-config.md +++ b/_docs/concepts/policy-and-control/mixer-config.md @@ -7,6 +7,7 @@ order: 30 layout: docs type: markdown --- +{% include home.html %} This page describes Mixer's configuration model. @@ -28,7 +29,7 @@ aspects of a Mixer deployment by manipulating configuration records. - **Scoped**. Configuration is described hierarchically, enabling both coarse global control as well as fine-grained local control. -- **Flexible**. The configuration model is built around Istio's [attributes](/docs/concepts/policy-and-control/attributes.html), +- **Flexible**. The configuration model is built around Istio's [attributes](./attributes.html), enabling operators unprecedented control over the policies used and telemetry produced within a deployment. - **Robust**. The configuration model is designed to provide maximum static correctness guarantees to help reduce @@ -213,7 +214,7 @@ aspect configuration formats can be found in *TBD*. #### Attribute expressions -Mixer features a number of independent [request processing phases](/docs/concepts/policy-and-control/mixer.html#request-phases). +Mixer features a number of independent [request processing phases](./mixer.html#request-phases). The *Attribute Processing* phase is responsible for ingesting a set of attributes and producing the adapter parameters necessary to invoke individual adapters. The phase operates by evaluating a series of *attribute expressions*. @@ -447,7 +448,7 @@ manifests: ## Examples -You can find fully formed examples of Mixer configuration by visiting the [Samples](/docs/samples). As +You can find fully formed examples of Mixer configuration by visiting the [Samples]({{home}}/docs/samples). As a specific example, here is the [BookInfo configuration](https://raw.githubusercontent.com/istio/istio/master/demos/mixer-config-quota-bookinfo.yaml). ## Configuration API diff --git a/_docs/concepts/policy-and-control/mixer.md b/_docs/concepts/policy-and-control/mixer.md index 3e0e04c6ed..f54719d97d 100644 --- a/_docs/concepts/policy-and-control/mixer.md +++ b/_docs/concepts/policy-and-control/mixer.md @@ -40,7 +40,7 @@ streams intended for both the service operator as well as for service consumers. management tool to provide some fairness between service consumers when contending for limited resources. Rate limits are examples of quotas. -These mechanisms are applied based on a set of [attributes](/docs/concepts/policy-and-control/attributes.html) that are +These mechanisms are applied based on a set of [attributes](./attributes.html) that are materialized for every request into Mixer. Within Istio, Envoy depends heavily on Mixer. Services running within the mesh can also use Mixer to report telemetry or manage quotas. (Note: as of Istio Alpha, only Envoy can call Mixer.) diff --git a/_docs/concepts/traffic-management/handling-failures.md b/_docs/concepts/traffic-management/handling-failures.md index 8c105e5d4d..800cea25ec 100644 --- a/_docs/concepts/traffic-management/handling-failures.md +++ b/_docs/concepts/traffic-management/handling-failures.md @@ -7,6 +7,7 @@ order: 30 layout: docs type: markdown --- +{% include home.html %} Envoy provides a set of out-of-the-box _opt-in_ failure recovery features that can be taken advantage of by the services in an application. Features @@ -41,9 +42,9 @@ and prevent localized failures from cascading instability to other nodes. Istio's traffic management rules allow operators to set global defaults for failure recovery per service/version. However, consumers of a service can also override -[timeout](/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.HTTPTimeout.SimpleTimeoutPolicy) +[timeout]({{home}}/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.HTTPTimeout.SimpleTimeoutPolicy) and -[retry](/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.HTTPRetry.SimpleRetryPolicy) +[retry]({{home}}/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.HTTPRetry.SimpleRetryPolicy) defaults by providing request-level overrides through special HTTP headers. With the Envoy proxy implmentation, the headers are "x-envoy-upstream-rq-timeout-ms" and "x-envoy-max-retries", respectively. diff --git a/_docs/concepts/traffic-management/rules-configuration.md b/_docs/concepts/traffic-management/rules-configuration.md index 21b4823cd6..e41a12b42c 100644 --- a/_docs/concepts/traffic-management/rules-configuration.md +++ b/_docs/concepts/traffic-management/rules-configuration.md @@ -7,7 +7,7 @@ order: 50 layout: docs type: markdown --- - +{% include home.html %} Istio provides a simple Domain-specific language (DSL) to control how API calls and layer-4 traffic flow across various @@ -15,7 +15,7 @@ services in the application deployment. The DSL allows the operator to configure service-level properties such as circuit breakers, timeouts, retries, as well as set up common continuous deployment tasks such as canary rollouts, A/B testing, staged rollouts with %-based traffic splits, -etc. See [routing rules reference](/docs/reference/api/proxy-config.html) for detailed information. +etc. See [routing rules reference]({{home}}/docs/reference/api/proxy-config.html) for detailed information. For example, a simple rule to send 100% of incoming traffic for a "reviews" service to version "v1" can be described using the Rules DSL as @@ -34,8 +34,8 @@ routed. In a Kubernetes deployment of Istio, the route *tag* "version: v1" corresponds to a Kubernetes *label* "version: v1". The rule ensures that only Kubernetes pods containing the label "version: v1" will receive traffic. Rules can be configured using the -[istioctl CLI](/docs/reference/commands/istioctl/istioctl.html). See the -[configuring request routing task](/docs/tasks/request-routing.html) for +[istioctl CLI]({{home}}/docs/reference/commands/istioctl.html). See the +[configuring request routing task]({{home}}/docs/tasks/request-routing.html) for examples. There are two types of rules in Istio, **Routes** and **Destination @@ -177,9 +177,9 @@ httpReqRetries: ``` Note that request timeouts and retries can also be -[overridden on a per-request basis](/docs/concepts/traffic-management/handling-failures.html#fine-tuning). +[overridden on a per-request basis](./handling-failures.html#fine-tuning). -See the [request timeouts task](/docs/tasks/request-timeouts.html) for a demonstration of timeout control. +See the [request timeouts task]({{home}}/docs/tasks/request-timeouts.html) for a demonstration of timeout control. ### Injecting faults in the request path @@ -238,7 +238,7 @@ httpFault: httpStatus: 400 ``` -To see fault injection in action, see the [fault injection task](/docs/tasks/fault-injection.html). +To see fault injection in action, see the [fault injection task]({{home}}/docs/tasks/fault-injection.html). ### Rules have precedence @@ -341,7 +341,7 @@ circuitBreaker: ``` The complete set of simple circuit breaker fields can be found -[here](/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy). +[here]({{home}}/docs/reference/api/proxy-config.html#istio.proxy.v1alpha.config.CircuitBreaker.SimpleCircuitBreakerPolicy). ### Destination Policy evaluation diff --git a/_docs/concepts/what-is-istio/architecture.md b/_docs/concepts/what-is-istio/architecture.md index ea42dfd873..f3cf8064e1 100644 --- a/_docs/concepts/what-is-istio/architecture.md +++ b/_docs/concepts/what-is-istio/architecture.md @@ -7,7 +7,7 @@ order: 30 layout: docs type: markdown --- - +{% include home.html %} This page presents an architectural overview for the Istio service mesh. @@ -50,7 +50,7 @@ Mixer is responsible for enforcing access control and usage policies across the services. The proxy extracts request level attributes which are sent to Mixer for evaluation. More information on the attribute extraction and policy evaluation can be found here. Mixer includes a flexible plugin model enabling it to interface with a variety of host environments and infrastructure backends, abstracting -the Envoy proxy and Istio-managed services from these details. More on Mixer [here](/docs/concepts/policy-and-control/mixer.html). +the Envoy proxy and Istio-managed services from these details. More on Mixer [here]({{home}}/docs/concepts/policy-and-control/mixer.html). ## Istio-Manager diff --git a/_docs/index.md b/_docs/index.md index 3acac52a2b..4d61ca476d 100644 --- a/_docs/index.md +++ b/_docs/index.md @@ -8,10 +8,7 @@ order: 0 layout: docs type: markdown --- -{% assign home = "" %} -{% if site.github.environment == "dotcom" %} -{% assign home = site.baseurl %} -{% endif %} +{% include home.html %} # Welcome @@ -31,5 +28,5 @@ command-line options, configuration options, API definitions, and procedures. We're always looking for help improving our documentation, so please don't hesitate to [file an issue](https://github.com/istio/istio.github.io/issues/new) if you see some problem. -Or better yet, submit your own [contributions](/docs/reference/contribute/editing.html) to help +Or better yet, submit your own [contributions]({{home}}/docs/reference/contribute/editing.html) to help make our docs better. \ No newline at end of file diff --git a/_docs/reference/api/attribute-vocabulary.md b/_docs/reference/api/attribute-vocabulary.md index cbf5081ca4..fe82b3d92c 100644 --- a/_docs/reference/api/attribute-vocabulary.md +++ b/_docs/reference/api/attribute-vocabulary.md @@ -7,9 +7,10 @@ order: 10 layout: docs type: markdown --- +{% include home.html %} Attributes are a central concept used throughout Istio. You can find a description of what attributes are -and what they are used for [here](/docs/concepts/policy-and-control/attributes.html). +and what they are used for [here]({{home}}/docs/concepts/policy-and-control/attributes.html). A given Istio deployment has a fixed vocabulary of attributes that it understands. The specific vocabulary is determined by the set of attribute producers being used in the deployment. The primary attribute producer in Istio diff --git a/_docs/reference/contribute/creating-a-pull-request.md b/_docs/reference/contribute/creating-a-pull-request.md index a158ad312c..b8821fffe2 100644 --- a/_docs/reference/contribute/creating-a-pull-request.md +++ b/_docs/reference/contribute/creating-a-pull-request.md @@ -37,8 +37,8 @@ documentation repository in your GitHub account. The copy is called a *fork*. a new branch to use for your contribution. 1. In your new branch, make your changes and commit them. If you want to -[write a new topic](/docs/reference/contribute/writing-a-new-topic.html), -choose the [page-type](writing-a-new-topic.html#choosing-a-page-type) +[write a new topic](./writing-a-new-topic.html), +choose the [page-type](./writing-a-new-topic.html#choosing-a-page-type) that is the best fit for your content. ## Submitting a pull request diff --git a/_docs/reference/contribute/staging-your-changes.md b/_docs/reference/contribute/staging-your-changes.md index 6d11f70d5d..76d68250ab 100644 --- a/_docs/reference/contribute/staging-your-changes.md +++ b/_docs/reference/contribute/staging-your-changes.md @@ -14,7 +14,7 @@ to the Istio documentation. ## Before you begin Create a fork of the Istio documentation repository as described in -[Creating a Doc Pull Request](/docs/reference/contribute/creating-a-pull-request.html). +[Creating a Doc Pull Request](./creating-a-pull-request.html). ## Staging locally diff --git a/_docs/reference/contribute/style-guide.md b/_docs/reference/contribute/style-guide.md index 6b7597b382..1df964f139 100644 --- a/_docs/reference/contribute/style-guide.md +++ b/_docs/reference/contribute/style-guide.md @@ -16,7 +16,7 @@ propose changes to this document in a pull request. For additional information on creating new content for the Istio docs, follow the instructions on -[Creating a Doc Pull Request](/docs/reference/contribute/creating-a-pull-request.html). +[Creating a Doc Pull Request](./creating-a-pull-request.html). ## Formatting standards diff --git a/_docs/reference/contribute/writing-a-new-topic.md b/_docs/reference/contribute/writing-a-new-topic.md index a8c2b3312b..ec6e9e8f1f 100644 --- a/_docs/reference/contribute/writing-a-new-topic.md +++ b/_docs/reference/contribute/writing-a-new-topic.md @@ -13,7 +13,7 @@ This page shows how to create a new Istio documentation topic. ## Before you begin You first need to create a fork of the Istio documentation repository as described in -[Creating a Doc Pull Request](/docs/reference/contribute/creating-a-pull-request.html). +[Creating a Doc Pull Request](./creating-a-pull-request.html). ## Choosing a page type diff --git a/_docs/reference/glossary.md b/_docs/reference/glossary.md index 1e038f694a..99fa55268d 100644 --- a/_docs/reference/glossary.md +++ b/_docs/reference/glossary.md @@ -7,6 +7,7 @@ order: 40 layout: docs type: markdown --- +{% include home.html %}