From 9f3e98014707543788566cc5a8263c1f626b8f16 Mon Sep 17 00:00:00 2001 From: Martin Taillefer Date: Mon, 11 Jun 2018 15:07:32 -0700 Subject: [PATCH] Add support for an auto-generated See Also section on every page. (#1364) - We now automatically generate a See Also section on pages when possible. The links are determined by a reverse index based on the keywords assigned to each page in its front-matter. - Do a pass to assign keywords to all our pages to populate the See Also links. - Leverage the keywords in the front-matter to generate a keyword metadata entry for each generated page. --- config.toml | 18 ++++++++++++++++++ .../about/contribute/writing-a-new-topic.md | 13 +++++++------ content/blog/2017/0.1-canary.md | 1 + content/blog/2017/adapter-model.md | 1 + content/blog/2017/mixer-spof-myth.md | 1 + content/blog/2018/aws-nlb.md | 1 + content/blog/2018/egress-https.md | 1 + content/blog/2018/egress-tcp.md | 1 + content/blog/2018/soft-multitenancy.md | 1 + content/blog/2018/traffic-mirroring.md | 1 + content/blog/2018/v1alpha3-routing.md | 1 + content/community/_index.md | 1 + .../concepts/policies-and-telemetry/config.md | 1 + .../policies-and-telemetry/overview.md | 1 + content/docs/concepts/security/authn-policy.md | 1 + content/docs/concepts/security/mutual-tls.md | 1 + content/docs/concepts/security/rbac.md | 1 + .../traffic-management/fault-injection.md | 1 + .../traffic-management/handling-failures.md | 1 + .../traffic-management/load-balancing.md | 1 + .../concepts/traffic-management/overview.md | 1 + .../docs/concepts/traffic-management/pilot.md | 1 + .../traffic-management/request-routing.md | 1 + .../traffic-management/rules-configuration.md | 1 + content/docs/guides/integrating-vms.md | 1 + content/docs/guides/intelligent-routing.md | 1 + content/docs/guides/telemetry.md | 1 + content/docs/setup/consul/_index.md | 1 + content/docs/setup/consul/install.md | 1 + content/docs/setup/consul/quick-start.md | 1 + content/docs/setup/eureka/_index.md | 1 + content/docs/setup/eureka/install.md | 1 + content/docs/setup/eureka/quick-start.md | 1 + content/docs/setup/kubernetes/_index.md | 1 + .../docs/setup/kubernetes/advanced-install.md | 2 +- .../docs/setup/kubernetes/ansible-install.md | 1 + content/docs/setup/kubernetes/helm-install.md | 1 + .../docs/setup/kubernetes/mesh-expansion.md | 1 + .../setup/kubernetes/multicluster-install.md | 1 + .../setup/kubernetes/quick-start-gke-dm.md | 1 + content/docs/setup/kubernetes/quick-start.md | 1 + .../docs/setup/kubernetes/sidecar-injection.md | 1 + .../docs/setup/kubernetes/upgrading-istio.md | 1 + .../tasks/policy-enforcement/rate-limiting.md | 1 + content/docs/tasks/security/authn-policy.md | 1 + .../tasks/security/basic-access-control.md | 1 + content/docs/tasks/security/health-check.md | 1 + content/docs/tasks/security/https-overlay.md | 1 + content/docs/tasks/security/mutual-tls.md | 1 + content/docs/tasks/security/plugin-ca-cert.md | 1 + .../security/role-based-access-control.md | 1 + .../tasks/security/secure-access-control.md | 1 + .../tasks/telemetry/distributed-tracing.md | 1 + content/docs/tasks/telemetry/fluentd.md | 1 + content/docs/tasks/telemetry/metrics-logs.md | 1 + .../docs/tasks/telemetry/querying-metrics.md | 1 + content/docs/tasks/telemetry/servicegraph.md | 1 + content/docs/tasks/telemetry/tcp-metrics.md | 1 + .../tasks/telemetry/using-istio-dashboard.md | 1 + .../docs/tasks/traffic-management/_index.md | 2 +- .../traffic-management/circuit-breaking.md | 1 + .../tasks/traffic-management/egress-tcp.md | 1 + .../docs/tasks/traffic-management/egress.md | 1 + .../traffic-management/fault-injection.md | 5 +---- .../docs/tasks/traffic-management/ingress.md | 1 + .../docs/tasks/traffic-management/mirroring.md | 1 + .../traffic-management/request-routing.md | 1 + .../traffic-management/request-timeouts.md | 1 + .../traffic-management/traffic-shifting.md | 1 + layouts/_default/baseof.html | 6 ++++++ layouts/_default/taxonomy.html | 2 -- layouts/_default/terms.html | 2 -- layouts/partials/primary-bottom.html | 9 +++++++++ 73 files changed, 107 insertions(+), 16 deletions(-) delete mode 100644 layouts/_default/taxonomy.html delete mode 100644 layouts/_default/terms.html diff --git a/config.toml b/config.toml index 92ef61ea7b..3c4bd3b9ad 100644 --- a/config.toml +++ b/config.toml @@ -25,3 +25,21 @@ enableEmoji = true [outputs] home = ["HTML"] section = ["HTML"] + +[related] + # Only include matches with rank >= threshold. This is a normalized rank between 0 and 100. + threshold = 80 + + # To get stable "See also" sections we, by default, exclude newer related pages. + includeNewer = true + + # Will lower case keywords in both queries and in the indexes. + toLower = false + + [[related.indices]] + name = "keywords" + weight = 150 + + [[related.indices]] + name = "tags" + weight = 100 diff --git a/content/about/contribute/writing-a-new-topic.md b/content/about/contribute/writing-a-new-topic.md index 180195635f..60e6f695c4 100644 --- a/content/about/contribute/writing-a-new-topic.md +++ b/content/about/contribute/writing-a-new-topic.md @@ -84,20 +84,21 @@ chunk of front matter you should start with: ```yaml --- title: -description: <overview> -weight: <order> +description: <description> +weight: <weight> +keywords: [keyword1,keyword2,...] --- ``` -Copy the above at the start of your new markdown file and update -the `<title>`, `<description>` and `<weight>` fields for your particular file. The available front -matter fields are: +Copy the above at the start of your new markdown file and update the information fields. +The available front matter fields are: |Field | Description |---------------|------------ |`title` | The short title of the page |`description` | A one-line description of what the topic is about -|`weight` | An integer used to determine the sort order of this page relative to other pages in the same directory. +|`weight` | An integer used to determine the sort order of this page relative to other pages in the same directory +|`keywords` | An array of keywords describing the page, used to create the web of See Also links |`draft` | When true, prevents the page from showing up in any navigation area |`publishdate` | For blog posts, indicates the date of publication of the post |`subtitle` | For blog posts, supplies an optional subtitle to be displayed below the main title diff --git a/content/blog/2017/0.1-canary.md b/content/blog/2017/0.1-canary.md index 502a0c1955..b38b25dc71 100644 --- a/content/blog/2017/0.1-canary.md +++ b/content/blog/2017/0.1-canary.md @@ -4,6 +4,7 @@ description: Using Istio to create autoscaled canary deployments publishdate: 2017-06-14 attribution: Frank Budinsky weight: 98 +keywords: [traffic-management,canary] aliases: - /blog/canary-deployments-using-istio.html --- diff --git a/content/blog/2017/adapter-model.md b/content/blog/2017/adapter-model.md index ffb91d54a0..5d89ff30e3 100644 --- a/content/blog/2017/adapter-model.md +++ b/content/blog/2017/adapter-model.md @@ -5,6 +5,7 @@ publishdate: 2017-11-03 subtitle: Extending Istio to integrate with a world of infrastructure backends attribution: Martin Taillefer weight: 95 +keywords: [adapters,mixer,policies,telemetry] aliases: - /blog/mixer-adapter-model.html --- diff --git a/content/blog/2017/mixer-spof-myth.md b/content/blog/2017/mixer-spof-myth.md index 57418a8117..9a5d97bb61 100644 --- a/content/blog/2017/mixer-spof-myth.md +++ b/content/blog/2017/mixer-spof-myth.md @@ -4,6 +4,7 @@ description: Improving availability and reducing latency publishdate: 2017-12-07 subtitle: Improving availability and reducing latency attribution: Martin Taillefer +keywords: [adapters,mixer,policies,telemetry,availability,latency] weight: 94 aliases: - /blog/posts/2017/mixer-spof-myth.html diff --git a/content/blog/2018/aws-nlb.md b/content/blog/2018/aws-nlb.md index ed9cfe76cf..705c35478e 100644 --- a/content/blog/2018/aws-nlb.md +++ b/content/blog/2018/aws-nlb.md @@ -5,6 +5,7 @@ publishdate: 2018-04-20 subtitle: Ingress AWS Network Load Balancer attribution: Julien SENON weight: 89 +keywords: [ingress,traffic-management,aws] --- This post provides instructions to use and configure ingress Istio with [AWS Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/introduction.html). diff --git a/content/blog/2018/egress-https.md b/content/blog/2018/egress-https.md index 212652ccaf..3d4c8237f7 100644 --- a/content/blog/2018/egress-https.md +++ b/content/blog/2018/egress-https.md @@ -5,6 +5,7 @@ publishdate: 2018-01-31 subtitle: Egress Rules for HTTPS traffic attribution: Vadim Eisenberg weight: 93 +keywords: [traffic-management,egress,https] --- In many cases, not all the parts of a microservices-based application reside in a _service mesh_. Sometimes, the microservices-based applications use functionality provided by legacy systems that reside outside the mesh. We may want to migrate these systems to the service mesh gradually. Until these systems are migrated, they must be accessed by the applications inside the mesh. In other cases, the applications use web services provided by external organizations, often over the World Wide Web. diff --git a/content/blog/2018/egress-tcp.md b/content/blog/2018/egress-tcp.md index 9b2e7129c1..81499918b6 100644 --- a/content/blog/2018/egress-tcp.md +++ b/content/blog/2018/egress-tcp.md @@ -5,6 +5,7 @@ publishdate: 2018-02-06 subtitle: Egress rules for TCP traffic attribution: Vadim Eisenberg weight: 92 +keywords: [traffic-management,egress,tcp] --- In my previous blog post, [Consuming External Web Services](/blog/2018/egress-https/), I described how external services can be consumed by in-mesh Istio applications via HTTPS. In this post, I demonstrate consuming external services over TCP. I use the [Istio Bookinfo sample application](/docs/guides/bookinfo/), the version in which the book ratings data is persisted in a MySQL database. I deploy this database outside the cluster and configure the _ratings_ microservice to use it. I define an [egress rule](/docs/reference/config/istio.routing.v1alpha1/#EgressRule) to allow the in-mesh applications to access the external database. diff --git a/content/blog/2018/soft-multitenancy.md b/content/blog/2018/soft-multitenancy.md index b89846069e..d86c34c984 100644 --- a/content/blog/2018/soft-multitenancy.md +++ b/content/blog/2018/soft-multitenancy.md @@ -5,6 +5,7 @@ publishdate: 2018-04-19 subtitle: Using multiple Istio control planes and RBAC to create multi-tenancy attribution: John Joyce and Rich Curran weight: 90 +keywords: [tenancy] --- Multi-tenancy is commonly used in many environments across many different applications, diff --git a/content/blog/2018/traffic-mirroring.md b/content/blog/2018/traffic-mirroring.md index b43c235fe6..3ab7038a19 100644 --- a/content/blog/2018/traffic-mirroring.md +++ b/content/blog/2018/traffic-mirroring.md @@ -5,6 +5,7 @@ publishdate: 2018-02-08 subtitle: Routing rules for HTTP traffic attribution: Christian Posta weight: 91 +keywords: [traffic-management,mirroring] --- Trying to enumerate all the possible combinations of test cases for testing services in non-production/test environments can be daunting. In some cases, you'll find that all of the effort that goes into cataloging these use cases doesn't match up to real production use cases. Ideally, we could use live production use cases and traffic to help illuminate all of the feature areas of the service under test that we might miss in more contrived testing environments. diff --git a/content/blog/2018/v1alpha3-routing.md b/content/blog/2018/v1alpha3-routing.md index 5e42daf078..d33680befd 100644 --- a/content/blog/2018/v1alpha3-routing.md +++ b/content/blog/2018/v1alpha3-routing.md @@ -5,6 +5,7 @@ publishdate: 2018-04-25 subtitle: attribution: Frank Budinsky (IBM) and Shriram Rajagopalan (VMware) weight: 88 +keywords: [traffic-management] --- Up until now, Istio has provided a simple API for traffic management using four configuration resources: diff --git a/content/community/_index.md b/content/community/_index.md index c9d239ea17..2678d1dc58 100644 --- a/content/community/_index.md +++ b/content/community/_index.md @@ -1,6 +1,7 @@ --- title: Community description: Information on the various ways to participate and interact with the Istio community. +keywords: [community] sidebar_none: true --- Istio is an open source project with an active community that supports its use and on-going development. We'd love for you diff --git a/content/docs/concepts/policies-and-telemetry/config.md b/content/docs/concepts/policies-and-telemetry/config.md index ab9af6c448..d2a00335c8 100644 --- a/content/docs/concepts/policies-and-telemetry/config.md +++ b/content/docs/concepts/policies-and-telemetry/config.md @@ -2,6 +2,7 @@ title: Configuration description: An overview of the key concepts used to configure Istio's policy enforcement and telemetry collection features. weight: 30 +keywords: [policies,telemetry,control,config] aliases: - /docs/concepts/policy-and-control/mixer-config.html - /docs/concepts/policy-and-control/attributes.html diff --git a/content/docs/concepts/policies-and-telemetry/overview.md b/content/docs/concepts/policies-and-telemetry/overview.md index 68525dcc25..d516d92f99 100644 --- a/content/docs/concepts/policies-and-telemetry/overview.md +++ b/content/docs/concepts/policies-and-telemetry/overview.md @@ -2,6 +2,7 @@ title: Overview description: Describes the design of the policy and telemetry mechanisms. weight: 5 +keywords: [policies,telemetry,control] aliases: - /docs/concepts/policy-and-control/mixer.html --- diff --git a/content/docs/concepts/security/authn-policy.md b/content/docs/concepts/security/authn-policy.md index 63e64840d4..144a25326c 100644 --- a/content/docs/concepts/security/authn-policy.md +++ b/content/docs/concepts/security/authn-policy.md @@ -2,6 +2,7 @@ title: Authentication Policy description: Describes Istio's authentication policy weight: 10 +keywords: [security,authentication] aliases: - /docs/concepts/network-and-auth/auth.html --- diff --git a/content/docs/concepts/security/mutual-tls.md b/content/docs/concepts/security/mutual-tls.md index 2f800ff8c9..85cc5913a4 100644 --- a/content/docs/concepts/security/mutual-tls.md +++ b/content/docs/concepts/security/mutual-tls.md @@ -1,6 +1,7 @@ --- title: Mutual TLS Authentication description: Describes Istio's mutual TLS authentication architecture which provides a strong service identity and secure communication channels between services. +keywords: [security,mutual-tls] weight: 10 --- diff --git a/content/docs/concepts/security/rbac.md b/content/docs/concepts/security/rbac.md index 19e50a2d66..22610175fe 100644 --- a/content/docs/concepts/security/rbac.md +++ b/content/docs/concepts/security/rbac.md @@ -2,6 +2,7 @@ title: Istio Role-Based Access Control (RBAC) description: Describes Istio RBAC which provides access control for services in Istio Mesh. weight: 20 +keywords: [security,rbac,authorization] --- ## Overview diff --git a/content/docs/concepts/traffic-management/fault-injection.md b/content/docs/concepts/traffic-management/fault-injection.md index 72b118c13f..1f5d0cd95b 100644 --- a/content/docs/concepts/traffic-management/fault-injection.md +++ b/content/docs/concepts/traffic-management/fault-injection.md @@ -2,6 +2,7 @@ title: Fault Injection description: Introduces the idea of systematic fault injection that can be used to uncover conflicting failure recovery policies across services. weight: 40 +keywords: [traffic-management,fault-injection] --- While Envoy sidecar/proxy provides a host of diff --git a/content/docs/concepts/traffic-management/handling-failures.md b/content/docs/concepts/traffic-management/handling-failures.md index 332ec4f276..161dedd2f9 100644 --- a/content/docs/concepts/traffic-management/handling-failures.md +++ b/content/docs/concepts/traffic-management/handling-failures.md @@ -2,6 +2,7 @@ title: Handling Failures description: An overview of failure recovery capabilities in Envoy that can be leveraged by unmodified applications to improve robustness and prevent cascading failures. weight: 30 +keywords: [traffic-management,handling-failures] --- Envoy provides a set of out-of-the-box _opt-in_ failure recovery features diff --git a/content/docs/concepts/traffic-management/load-balancing.md b/content/docs/concepts/traffic-management/load-balancing.md index 3e6caa7cd9..4a9ba01ffa 100644 --- a/content/docs/concepts/traffic-management/load-balancing.md +++ b/content/docs/concepts/traffic-management/load-balancing.md @@ -2,6 +2,7 @@ title: Discovery & Load Balancing description: Describes how traffic is load balanced across instances of a service in the mesh. weight: 25 +keywords: [traffic-management,load-balancing] --- This page describes how Istio load balances traffic across instances of a diff --git a/content/docs/concepts/traffic-management/overview.md b/content/docs/concepts/traffic-management/overview.md index 83af01e8ec..f70e38c4cb 100644 --- a/content/docs/concepts/traffic-management/overview.md +++ b/content/docs/concepts/traffic-management/overview.md @@ -2,6 +2,7 @@ title: Overview description: Provides a conceptual overview of traffic management in Istio and the features it enables. weight: 1 +keywords: [traffic-management] --- This page provides an overview of how traffic management works diff --git a/content/docs/concepts/traffic-management/pilot.md b/content/docs/concepts/traffic-management/pilot.md index 45fb287f4f..4133833286 100644 --- a/content/docs/concepts/traffic-management/pilot.md +++ b/content/docs/concepts/traffic-management/pilot.md @@ -2,6 +2,7 @@ title: Pilot description: Introduces Pilot, the component responsible for managing a distributed deployment of Envoy proxies in the service mesh. weight: 10 +keywords: [traffic-management,pilot] aliases: - /docs/concepts/traffic-management/manager.html --- diff --git a/content/docs/concepts/traffic-management/request-routing.md b/content/docs/concepts/traffic-management/request-routing.md index 0fef1939c4..814d6fecba 100644 --- a/content/docs/concepts/traffic-management/request-routing.md +++ b/content/docs/concepts/traffic-management/request-routing.md @@ -2,6 +2,7 @@ title: Request Routing description: Describes how requests are routed between services in an Istio service mesh. weight: 20 +keywords: [traffic-management,routing] --- This page describes how requests are routed between services in an Istio service mesh. diff --git a/content/docs/concepts/traffic-management/rules-configuration.md b/content/docs/concepts/traffic-management/rules-configuration.md index 0e4c504910..1d42e477e0 100644 --- a/content/docs/concepts/traffic-management/rules-configuration.md +++ b/content/docs/concepts/traffic-management/rules-configuration.md @@ -2,6 +2,7 @@ title: Rules Configuration description: Provides a high-level overview of the configuration model used by Istio to configure traffic management rules in the service mesh. weight: 50 +keywords: [traffic-management,rules] --- Istio provides a simple configuration model to diff --git a/content/docs/guides/integrating-vms.md b/content/docs/guides/integrating-vms.md index 287d91f3e3..bfbff1139d 100644 --- a/content/docs/guides/integrating-vms.md +++ b/content/docs/guides/integrating-vms.md @@ -2,6 +2,7 @@ title: Integrating Virtual Machines description: This sample deploys the Bookinfo services across Kubernetes and a set of virtual machines, and illustrates how to use the Istio service mesh to control this infrastructure as a single mesh. weight: 60 +keywords: [vms] --- This sample deploys the Bookinfo services across Kubernetes and a set of diff --git a/content/docs/guides/intelligent-routing.md b/content/docs/guides/intelligent-routing.md index 4f704d1d39..1e4aa77fa3 100644 --- a/content/docs/guides/intelligent-routing.md +++ b/content/docs/guides/intelligent-routing.md @@ -2,6 +2,7 @@ title: Intelligent Routing description: This guide demonstrates how to use various traffic management capabilities of an Istio service mesh. weight: 20 +keywords: [traffic-management,routing] --- This guide demonstrates how to use various traffic management capabilities diff --git a/content/docs/guides/telemetry.md b/content/docs/guides/telemetry.md index 0a45e34d27..14f5511f42 100644 --- a/content/docs/guides/telemetry.md +++ b/content/docs/guides/telemetry.md @@ -2,6 +2,7 @@ title: In-Depth Telemetry description: This sample demonstrates how to obtain uniform metrics, logs, traces across different services using Istio Mixer and Istio sidecar. weight: 30 +keywords: [telemetry] --- This sample demonstrates how to obtain uniform metrics, logs, traces across different services using Istio Mixer and Istio sidecar. diff --git a/content/docs/setup/consul/_index.md b/content/docs/setup/consul/_index.md index 4ec6af3477..d3f144e3ed 100644 --- a/content/docs/setup/consul/_index.md +++ b/content/docs/setup/consul/_index.md @@ -3,4 +3,5 @@ title: Nomad & Consul description: Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad. weight: 20 type: section-index +keywords: [consul] --- \ No newline at end of file diff --git a/content/docs/setup/consul/install.md b/content/docs/setup/consul/install.md index 57c1f6a6ee..36b2e7b590 100644 --- a/content/docs/setup/consul/install.md +++ b/content/docs/setup/consul/install.md @@ -2,6 +2,7 @@ title: Installation description: Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad. weight: 30 +keywords: [consul] --- > Setup on Nomad has not been tested. diff --git a/content/docs/setup/consul/quick-start.md b/content/docs/setup/consul/quick-start.md index a3beb6b613..9c12426fdf 100644 --- a/content/docs/setup/consul/quick-start.md +++ b/content/docs/setup/consul/quick-start.md @@ -2,6 +2,7 @@ title: Quick Start on Docker description: Quick Start instructions to setup the Istio service mesh with Docker Compose. weight: 10 +keywords: [consul] --- Quick Start instructions to install and configure Istio in a Docker Compose setup. diff --git a/content/docs/setup/eureka/_index.md b/content/docs/setup/eureka/_index.md index 762b3efed1..83bd84395d 100644 --- a/content/docs/setup/eureka/_index.md +++ b/content/docs/setup/eureka/_index.md @@ -3,4 +3,5 @@ title: Eureka description: Instructions for installing the Istio control plane in a Eureka based environment. weight: 30 type: section-index +keywords: [eureka] --- diff --git a/content/docs/setup/eureka/install.md b/content/docs/setup/eureka/install.md index 88c431adda..b93c91fc4b 100644 --- a/content/docs/setup/eureka/install.md +++ b/content/docs/setup/eureka/install.md @@ -2,6 +2,7 @@ title: Installation description: Instructions for installing the Istio control plane in an Eureka based environment. weight: 30 +keywords: [eureka] --- Using Istio in a non-Kubernetes environment involves a few key tasks: diff --git a/content/docs/setup/eureka/quick-start.md b/content/docs/setup/eureka/quick-start.md index fe0ff05f4c..06524c3233 100644 --- a/content/docs/setup/eureka/quick-start.md +++ b/content/docs/setup/eureka/quick-start.md @@ -2,6 +2,7 @@ title: Quick Start on Docker description: Quick Start instructions to setup the Istio service mesh with Docker Compose. weight: 10 +keywords: [eureka] --- Quick Start instructions to install and configure Istio in a Docker Compose setup. diff --git a/content/docs/setup/kubernetes/_index.md b/content/docs/setup/kubernetes/_index.md index 9b577f8894..63ea222451 100644 --- a/content/docs/setup/kubernetes/_index.md +++ b/content/docs/setup/kubernetes/_index.md @@ -2,6 +2,7 @@ title: Kubernetes description: Instructions for installing the Istio control plane on Kubernetes and adding VMs into the mesh. weight: 10 +keywords: [kubernetes] type: section-index aliases: - /docs/tasks/installing-istio.html diff --git a/content/docs/setup/kubernetes/advanced-install.md b/content/docs/setup/kubernetes/advanced-install.md index 86309b0cb5..f68a1eeab6 100644 --- a/content/docs/setup/kubernetes/advanced-install.md +++ b/content/docs/setup/kubernetes/advanced-install.md @@ -1,8 +1,8 @@ --- title: Advanced Install Options description: Instructions for customizing the Istio installation. - weight: 20 +keywords: [kubernetes] draft: true --- diff --git a/content/docs/setup/kubernetes/ansible-install.md b/content/docs/setup/kubernetes/ansible-install.md index a277ededce..3da43f4bd8 100644 --- a/content/docs/setup/kubernetes/ansible-install.md +++ b/content/docs/setup/kubernetes/ansible-install.md @@ -2,6 +2,7 @@ title: Installation with Ansible description: Install Istio with the included Ansible playbook. weight: 40 +keywords: [kubernetes,ansible] --- Instructions for the installation and configuration of Istio using Ansible. diff --git a/content/docs/setup/kubernetes/helm-install.md b/content/docs/setup/kubernetes/helm-install.md index db9e7a50d4..fb26c5527b 100644 --- a/content/docs/setup/kubernetes/helm-install.md +++ b/content/docs/setup/kubernetes/helm-install.md @@ -2,6 +2,7 @@ title: Installation with Helm description: Install Istio with the included Helm chart. weight: 30 +keywords: [kubernetes,helm] aliases: - /docs/setup/kubernetes/helm.html - /docs/tasks/integrating-services-into-istio.html diff --git a/content/docs/setup/kubernetes/mesh-expansion.md b/content/docs/setup/kubernetes/mesh-expansion.md index 516a3e5238..3747e8a9e1 100644 --- a/content/docs/setup/kubernetes/mesh-expansion.md +++ b/content/docs/setup/kubernetes/mesh-expansion.md @@ -2,6 +2,7 @@ title: Mesh Expansion description: Instructions for integrating VMs and bare metal hosts into an Istio mesh deployed on Kubernetes. weight: 60 +keywords: [kubernetes,vms] --- Instructions for integrating VMs and bare metal hosts into an Istio mesh diff --git a/content/docs/setup/kubernetes/multicluster-install.md b/content/docs/setup/kubernetes/multicluster-install.md index 3510b29663..f9fd6f5c85 100644 --- a/content/docs/setup/kubernetes/multicluster-install.md +++ b/content/docs/setup/kubernetes/multicluster-install.md @@ -2,6 +2,7 @@ title: Istio Multicluster description: Install Istio with multicluster support. weight: 65 +keywords: [kubernetes,multicluster] --- Instructions for the installation of Istio multicluster. diff --git a/content/docs/setup/kubernetes/quick-start-gke-dm.md b/content/docs/setup/kubernetes/quick-start-gke-dm.md index 6e34b6d6ef..f4e3a6855b 100644 --- a/content/docs/setup/kubernetes/quick-start-gke-dm.md +++ b/content/docs/setup/kubernetes/quick-start-gke-dm.md @@ -2,6 +2,7 @@ title: Quick Start with Google Kubernetes Engine description: Quick Start instructions to setup the Istio service using Google Kubernetes Engine (GKE) weight: 11 +keywords: [kubernetes,gke] --- Quick Start instructions to install and run Istio in [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/) (GKE) using [Google Cloud Deployment Manager](https://cloud.google.com/deployment-manager/). diff --git a/content/docs/setup/kubernetes/quick-start.md b/content/docs/setup/kubernetes/quick-start.md index a3d8caefe1..03a7342a95 100644 --- a/content/docs/setup/kubernetes/quick-start.md +++ b/content/docs/setup/kubernetes/quick-start.md @@ -2,6 +2,7 @@ title: Quick Start description: Quick start instructions to setup the Istio service mesh in a Kubernetes cluster. weight: 10 +keywords: [kubernetes] --- Quick start instructions to install and configure Istio in a Kubernetes cluster. diff --git a/content/docs/setup/kubernetes/sidecar-injection.md b/content/docs/setup/kubernetes/sidecar-injection.md index f73fa0ca72..e3fb009073 100644 --- a/content/docs/setup/kubernetes/sidecar-injection.md +++ b/content/docs/setup/kubernetes/sidecar-injection.md @@ -2,6 +2,7 @@ title: Installing the Istio Sidecar description: Instructions for installing the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI. weight: 50 +keywords: [kubernetes,sidecar,sidecar-injection] aliases: - /docs/setup/kubernetes/automatic-sidecar-inject.html --- diff --git a/content/docs/setup/kubernetes/upgrading-istio.md b/content/docs/setup/kubernetes/upgrading-istio.md index 9ab8ce4cf0..256e65c233 100644 --- a/content/docs/setup/kubernetes/upgrading-istio.md +++ b/content/docs/setup/kubernetes/upgrading-istio.md @@ -2,6 +2,7 @@ title: Upgrading Istio description: This guide demonstrates how to upgrade the Istio control plane and data plane independently. weight: 70 +keywords: [kubernetes,upgrading] --- This page describes how to upgrade an existing Istio deployment (including both control plane and sidecar proxy) to a new release of Istio. diff --git a/content/docs/tasks/policy-enforcement/rate-limiting.md b/content/docs/tasks/policy-enforcement/rate-limiting.md index f3c31ece1a..a21b90bc70 100644 --- a/content/docs/tasks/policy-enforcement/rate-limiting.md +++ b/content/docs/tasks/policy-enforcement/rate-limiting.md @@ -2,6 +2,7 @@ title: Enabling Rate Limits description: This task shows you how to use Istio to dynamically limit the traffic to a service. weight: 10 +keywords: [policies,quotas] aliases: - /docs/tasks/rate-limiting.html --- diff --git a/content/docs/tasks/security/authn-policy.md b/content/docs/tasks/security/authn-policy.md index 2c2c236156..a668c34034 100644 --- a/content/docs/tasks/security/authn-policy.md +++ b/content/docs/tasks/security/authn-policy.md @@ -2,6 +2,7 @@ title: Basic Authentication Policy description: Shows you how to use Istio authentication policy to setup mutual TLS and basic end-user authentication. weight: 10 +keywords: [security,authentication] aliases: - /docs/tasks/security/istio-auth.html --- diff --git a/content/docs/tasks/security/basic-access-control.md b/content/docs/tasks/security/basic-access-control.md index 08b989c81b..0c59c3ec3a 100644 --- a/content/docs/tasks/security/basic-access-control.md +++ b/content/docs/tasks/security/basic-access-control.md @@ -2,6 +2,7 @@ title: Basic Access Control description: Shows how to control access to a service using the Kubernetes labels. weight: 20 +keywords: [security,access-control] aliases: - /docs/tasks/basic-access-control.html --- diff --git a/content/docs/tasks/security/health-check.md b/content/docs/tasks/security/health-check.md index cfc9ffc176..00cd850627 100644 --- a/content/docs/tasks/security/health-check.md +++ b/content/docs/tasks/security/health-check.md @@ -2,6 +2,7 @@ title: Citadel health checking description: Shows how to enable Citadel health checking with Kubernetes. weight: 70 +keywords: [security,health-check] --- This task shows how to enable Kubernetes health checking for Citadel. Note this is an Alpha feature. diff --git a/content/docs/tasks/security/https-overlay.md b/content/docs/tasks/security/https-overlay.md index 4ef5f3ddc7..851afc713b 100644 --- a/content/docs/tasks/security/https-overlay.md +++ b/content/docs/tasks/security/https-overlay.md @@ -2,6 +2,7 @@ title: Mutual TLS over HTTPS description: Shows how to enable mutual TLS on HTTPS services. weight: 80 +keywords: [security,mutual-tls,https] --- This task shows how Istio Mutual TLS works with HTTPS services. It includes: diff --git a/content/docs/tasks/security/mutual-tls.md b/content/docs/tasks/security/mutual-tls.md index 632ef7b6bb..409cae13d1 100644 --- a/content/docs/tasks/security/mutual-tls.md +++ b/content/docs/tasks/security/mutual-tls.md @@ -2,6 +2,7 @@ title: Testing Mutual TLS description: Shows you how to verify and test Istio's automatic mutual TLS authentication. weight: 10 +keywords: [security,mutual-tls] --- Through this task, you will learn how to: diff --git a/content/docs/tasks/security/plugin-ca-cert.md b/content/docs/tasks/security/plugin-ca-cert.md index beaa97b423..119e868fe1 100644 --- a/content/docs/tasks/security/plugin-ca-cert.md +++ b/content/docs/tasks/security/plugin-ca-cert.md @@ -2,6 +2,7 @@ title: Plugging in external CA key and certificate description: Shows how operators can configure Citadel with existing root certificate, signing certificate and key. weight: 60 +keywords: [security,certificates] --- This task shows how operators can configure Citadel with existing root certificate, signing certificate and key. diff --git a/content/docs/tasks/security/role-based-access-control.md b/content/docs/tasks/security/role-based-access-control.md index c89c2235de..bbb5b67d7c 100644 --- a/content/docs/tasks/security/role-based-access-control.md +++ b/content/docs/tasks/security/role-based-access-control.md @@ -2,6 +2,7 @@ title: Role-Based Access Control description: Shows how to set up role-based access control for services in Istio mesh. weight: 40 +keywords: [security,access-control,rbac] --- This task shows how to set up role-based access control (RBAC) for services in Istio mesh. You can read more about Istio diff --git a/content/docs/tasks/security/secure-access-control.md b/content/docs/tasks/security/secure-access-control.md index 90623925ea..8fd0ae0ba6 100644 --- a/content/docs/tasks/security/secure-access-control.md +++ b/content/docs/tasks/security/secure-access-control.md @@ -2,6 +2,7 @@ title: Secure Access Control description: Shows how to securely control access to a service using service accounts. weight: 30 +keywords: [security,access-control] --- This task shows how to securely control access to a service, diff --git a/content/docs/tasks/telemetry/distributed-tracing.md b/content/docs/tasks/telemetry/distributed-tracing.md index df78d28ada..2cb1aed1ff 100644 --- a/content/docs/tasks/telemetry/distributed-tracing.md +++ b/content/docs/tasks/telemetry/distributed-tracing.md @@ -2,6 +2,7 @@ title: Distributed Tracing description: How to configure the proxies to send tracing requests to Zipkin or Jaeger weight: 10 +keywords: [telemetry,tracing] aliases: - /docs/tasks/zipkin-tracing.html --- diff --git a/content/docs/tasks/telemetry/fluentd.md b/content/docs/tasks/telemetry/fluentd.md index f2a6b52f7c..4af47119b0 100644 --- a/content/docs/tasks/telemetry/fluentd.md +++ b/content/docs/tasks/telemetry/fluentd.md @@ -2,6 +2,7 @@ title: Logging with Fluentd description: This task shows you how to configure Istio to log to a Fluentd daemon weight: 60 +keywords: [telemetry,logging] --- This task shows how to configure Istio to create custom log entries diff --git a/content/docs/tasks/telemetry/metrics-logs.md b/content/docs/tasks/telemetry/metrics-logs.md index ac27eab68b..41b6f8401e 100644 --- a/content/docs/tasks/telemetry/metrics-logs.md +++ b/content/docs/tasks/telemetry/metrics-logs.md @@ -2,6 +2,7 @@ title: Collecting Metrics and Logs description: This task shows you how to configure Istio to collect metrics and logs. weight: 20 +keywords: [telemetry,metrics] aliases: - /docs/tasks/metrics-logs.html --- diff --git a/content/docs/tasks/telemetry/querying-metrics.md b/content/docs/tasks/telemetry/querying-metrics.md index 64479b2f2c..4f4a3b5ed1 100644 --- a/content/docs/tasks/telemetry/querying-metrics.md +++ b/content/docs/tasks/telemetry/querying-metrics.md @@ -2,6 +2,7 @@ title: Querying Metrics from Prometheus description: This task shows you how to query for Istio Metrics using Prometheus. weight: 30 +keywords: [telemetry,metrics] --- This task shows you how to query for Istio Metrics using Prometheus. As part of diff --git a/content/docs/tasks/telemetry/servicegraph.md b/content/docs/tasks/telemetry/servicegraph.md index 15d03b5132..6da5293b18 100644 --- a/content/docs/tasks/telemetry/servicegraph.md +++ b/content/docs/tasks/telemetry/servicegraph.md @@ -2,6 +2,7 @@ title: Generating a Service Graph description: This task shows you how to generate a graph of services within an Istio mesh. weight: 50 +keywords: [telemetry,visualization] --- This task shows you how to generate a graph of services within an Istio mesh. diff --git a/content/docs/tasks/telemetry/tcp-metrics.md b/content/docs/tasks/telemetry/tcp-metrics.md index 1d0a8dbfba..e409f527e0 100644 --- a/content/docs/tasks/telemetry/tcp-metrics.md +++ b/content/docs/tasks/telemetry/tcp-metrics.md @@ -2,6 +2,7 @@ title: Collecting Metrics for TCP services description: This task shows you how to configure Istio to collect metrics for TCP services. weight: 25 +keywords: [telemetry,metrics,tcp] --- This task shows how to configure Istio to automatically gather telemetry for TCP diff --git a/content/docs/tasks/telemetry/using-istio-dashboard.md b/content/docs/tasks/telemetry/using-istio-dashboard.md index aa36a04e95..c63d98cebe 100644 --- a/content/docs/tasks/telemetry/using-istio-dashboard.md +++ b/content/docs/tasks/telemetry/using-istio-dashboard.md @@ -2,6 +2,7 @@ title: Visualizing Metrics with Grafana description: This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic. weight: 40 +keywords: [telemetry,visualization] --- This task shows you how to setup and use the Istio Dashboard to monitor mesh diff --git a/content/docs/tasks/traffic-management/_index.md b/content/docs/tasks/traffic-management/_index.md index 893ab732a2..65ea7c843c 100644 --- a/content/docs/tasks/traffic-management/_index.md +++ b/content/docs/tasks/traffic-management/_index.md @@ -1,6 +1,6 @@ --- title: Traffic Management -description: Describes tasks that demonstrate traffic routing features of Istio service mesh. +description: Tasks that demonstrate Istio's traffic routing features. weight: 15 type: section-index --- diff --git a/content/docs/tasks/traffic-management/circuit-breaking.md b/content/docs/tasks/traffic-management/circuit-breaking.md index 748c48ac2c..84b217e805 100644 --- a/content/docs/tasks/traffic-management/circuit-breaking.md +++ b/content/docs/tasks/traffic-management/circuit-breaking.md @@ -2,6 +2,7 @@ title: Circuit Breaking description: This task demonstrates the circuit-breaking capability for resilient applications weight: 50 +keywords: [traffic-management,circuit-breaking] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/egress-tcp.md b/content/docs/tasks/traffic-management/egress-tcp.md index bcd73c6d35..7502aac43c 100644 --- a/content/docs/tasks/traffic-management/egress-tcp.md +++ b/content/docs/tasks/traffic-management/egress-tcp.md @@ -2,6 +2,7 @@ title: Control Egress TCP Traffic description: Describes how to configure Istio to route TCP traffic from services in the mesh to external services. weight: 41 +keywords: [traffic-management,egress,tcp] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/egress.md b/content/docs/tasks/traffic-management/egress.md index fd7385e53c..36298f57c3 100644 --- a/content/docs/tasks/traffic-management/egress.md +++ b/content/docs/tasks/traffic-management/egress.md @@ -4,6 +4,7 @@ description: Describes how to configure Istio to route traffic from services in weight: 40 aliases: - /docs/tasks/egress.html +keywords: [traffic-management,egress] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/fault-injection.md b/content/docs/tasks/traffic-management/fault-injection.md index d15170f3dc..5545556551 100644 --- a/content/docs/tasks/traffic-management/fault-injection.md +++ b/content/docs/tasks/traffic-management/fault-injection.md @@ -2,6 +2,7 @@ title: Fault Injection description: This task shows how to inject delays and test the resiliency of your application. weight: 20 +keywords: [traffic-management,fault-injection] aliases: - /docs/tasks/fault-injection.html --- @@ -167,7 +168,3 @@ message. * If you are not planning to explore any follow-on tasks, refer to the [Bookinfo cleanup](/docs/guides/bookinfo/#cleanup) instructions to shutdown the application. - -## What's next - -* Learn more about [fault injection](/docs/concepts/traffic-management/fault-injection/). diff --git a/content/docs/tasks/traffic-management/ingress.md b/content/docs/tasks/traffic-management/ingress.md index dd3e39e009..c127d5eac8 100644 --- a/content/docs/tasks/traffic-management/ingress.md +++ b/content/docs/tasks/traffic-management/ingress.md @@ -2,6 +2,7 @@ title: Control Ingress Traffic description: Describes how to configure Istio to expose a service outside of the service mesh. weight: 30 +keywords: [traffic-management,ingress] aliases: - /docs/tasks/ingress.html --- diff --git a/content/docs/tasks/traffic-management/mirroring.md b/content/docs/tasks/traffic-management/mirroring.md index 9227a22e6d..fb31ec7db1 100644 --- a/content/docs/tasks/traffic-management/mirroring.md +++ b/content/docs/tasks/traffic-management/mirroring.md @@ -2,6 +2,7 @@ title: Mirroring description: This task demonstrates the traffic shadowing/mirroring capabilities of Istio weight: 60 +keywords: [traffic-management,mirroring] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/request-routing.md b/content/docs/tasks/traffic-management/request-routing.md index 012d897841..56983fe6fb 100644 --- a/content/docs/tasks/traffic-management/request-routing.md +++ b/content/docs/tasks/traffic-management/request-routing.md @@ -4,6 +4,7 @@ description: This task shows you how to configure dynamic request routing based weight: 10 aliases: - /docs/tasks/request-routing.html +keywords: [traffic-management,routing] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/request-timeouts.md b/content/docs/tasks/traffic-management/request-timeouts.md index 9376ac3e0d..46ff988378 100644 --- a/content/docs/tasks/traffic-management/request-timeouts.md +++ b/content/docs/tasks/traffic-management/request-timeouts.md @@ -4,6 +4,7 @@ description: This task shows you how to setup request timeouts in Envoy using Is weight: 28 aliases: - /docs/tasks/request-timeouts.html +keywords: [traffic-management,timeouts] --- > This task uses the new [v1alpha3 traffic management API](/blog/2018/v1alpha3-routing/). The old API has been deprecated and will be removed in the next Istio release. If you need to use the old version, follow the docs [here](https://archive.istio.io/v0.7/docs/tasks/traffic-management/). diff --git a/content/docs/tasks/traffic-management/traffic-shifting.md b/content/docs/tasks/traffic-management/traffic-shifting.md index c8444b946f..18fcdddccc 100644 --- a/content/docs/tasks/traffic-management/traffic-shifting.md +++ b/content/docs/tasks/traffic-management/traffic-shifting.md @@ -2,6 +2,7 @@ title: Traffic Shifting description: Shows you how to migrate traffic from an old to new version of a service. weight: 25 +keywords: [traffic-management,traffic-shifting] aliases: - /docs/tasks/traffic-management/version-migration.html --- diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index b27f960e35..c82064937e 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -13,6 +13,12 @@ <meta name="title" content="{{ .Title }}"> <meta name="description" content="{{ template "description" . }}"> + {{ if .Page.Params.keywords }} + <meta name="keywords" content="microservices,services,mesh,{{ delimit .Page.Params.keywords "," }}"> + {{ else }} + <meta name="keywords" content="microservices,services,mesh"> + {{ end }} + <!-- Open Graph protocol --> <meta name="og:title" content="{{ .Title }}"> <meta name="og:description" content="{{ template "description" . }}"> diff --git a/layouts/_default/taxonomy.html b/layouts/_default/taxonomy.html deleted file mode 100644 index e4e4a83b8a..0000000000 --- a/layouts/_default/taxonomy.html +++ /dev/null @@ -1,2 +0,0 @@ -{{ define "main" }} -{{ end }} diff --git a/layouts/_default/terms.html b/layouts/_default/terms.html deleted file mode 100644 index e4e4a83b8a..0000000000 --- a/layouts/_default/terms.html +++ /dev/null @@ -1,2 +0,0 @@ -{{ define "main" }} -{{ end }} diff --git a/layouts/partials/primary-bottom.html b/layouts/partials/primary-bottom.html index 63d86f48a3..eba3d71718 100644 --- a/layouts/partials/primary-bottom.html +++ b/layouts/partials/primary-bottom.html @@ -1,6 +1,15 @@ {{ $toc := partial "toc.html" (dict "page" .) }} {{ $needTOC := .Scratch.Get "needTOC" }} + {{ $related := .Site.RegularPages.Related . | first 5 }} + {{ with $related }} + <h2 id="see-also">See Also</h2> + <ul> + {{ range . }} + <li><a href="{{ .RelPermalink }}">{{ .Title }}</a>. {{ .Description }}</li> + {{ end }} + </ul> + {{ end }} </main> {{ if or .NextInSection .PrevInSection }}