Skip to content

Commit

Permalink
Update documentation of Istio component (#17967)
Browse files Browse the repository at this point in the history
* Update documentaion of Istio component

* Apply suggestions from code review

Co-authored-by: Natalia Sitko <[email protected]>

---------

Co-authored-by: Natalia Sitko <[email protected]>
  • Loading branch information
barchw and nataliasitko authored Aug 16, 2023
1 parent 695a26f commit 74710c0
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions resources/istio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,17 @@

[Istio](https://istio.io/) is an open-source service mesh providing a uniform way to integrate microservices, manage traffic flow across microservices, enforce policies, and aggregate telemetry data.

The documentation here is for developers only, please follow the installation instructions from [istio.io](https://istio.io/docs/setup/install/istioctl/) for all other use cases.
The Istio Helm chart includes the `istio-manager-config.yaml` file, which contains the configuration needed for the Istio module's installation.

The Istio Helm chart consists of the `istio-operator.yaml` file with tailored Istio including Kyma-specific changes and configuration options.

By default, this chart installs the following Istio components:
By default, the Istio module installs the following Istio components:

- ingressgateway
- egressgateway
- istiod (pilot, citadel, and galley)

To disable any of the components, change the corresponding `enabled` flag.
- istio-cni

## Installation

The installation of the Istio chart requires [Reconciler](https://github.com/kyma-incubator/reconciler/tree/main/pkg/reconciler/instances/istio). Reconciler uses `istioctl` and a rendered `istio-operator.yaml` file to install Istio on a cluster. To install the component, run:
The installation of the Istio chart requires [Reconciler](https://github.com/kyma-incubator/reconciler/tree/main/pkg/reconciler/instances/istio). Reconciler uses the [Istio library](https://github.com/istio/istio/tree/master/operator) and the `IstioOperatorConfiguration` file to install Istio on a cluster. To install the component, run:

```bash
kyma deploy --components istio@istio-system
Expand All @@ -28,11 +24,4 @@ kyma deploy --components istio@istio-system

The installation of Istio ships with a default configuration. There may be circumstances in which you want to change the defaults.

Istio offers an Istio Control Plane CR, which is used to configure the installation. See the list of the currently exposed parameters of the Istio component that you can override. To learn more, go to [`istio-operator.yaml`](https://github.com/kyma-project/kyma/blob/main/resources/istio/templates/istio-operator.yaml).

- **mesh.Config**
- **values.global**
- **values.pilot**
- **values.sidecarInjectorWebhook**

To override the default values, read how to [change Kyma settings](../../docs/04-operation-guides/operations/03-change-kyma-config-values.md).
Istio is installed as a module, which can be configured using the Istio custom resource. Visit the [Istio repository](https://github.com/kyma-project/istio) for more information.

0 comments on commit 74710c0

Please sign in to comment.