mirror of https://github.com/istio/istio.io.git
Clarify istioctl install support for helm options (#5302)
* Clarify istioctl helm option support * add helm deprecation warning to install options page * remove space * add prepend to .spelling * address review comments
This commit is contained in:
Frank Budinsky
Martin Taillefer
parent
facbed0482
commit
cdd8d7f50f
|
|
@ -419,6 +419,8 @@ preconfigured
|
|||
prefetching
|
||||
preformatted
|
||||
preload
|
||||
prepend
|
||||
prepending
|
||||
prepends
|
||||
prober
|
||||
programmatically
|
||||
|
|
|
|||
|
|
@ -6,13 +6,29 @@ keywords: [kubernetes,helm]
|
|||
force_inline_toc: true
|
||||
---
|
||||
|
||||
{{< warning >}}
|
||||
Installing Istio with Helm has been deprecated, however, you can still use these Helm configuration options when
|
||||
[installing Istio with {{< istioctl >}}](/docs/setup/install/operator/) by prepending the string "`values.`"
|
||||
to the option name. For example, instead of this `helm` command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ helm template ... --set global.mtls.enabled=true
|
||||
{{< /text >}}
|
||||
|
||||
You can use this `istioctl` command:
|
||||
|
||||
{{< text bash >}}
|
||||
$ istioctl manifest generate ... --set values.global.mtls.enabled=true
|
||||
{{< /text >}}
|
||||
|
||||
Refer to [customizing the configuration](/docs/setup/install/operator/#customizing-the-configuration) for details.
|
||||
{{< /warning >}}
|
||||
|
||||
{{< tip >}}
|
||||
Refer to [Installation Options Changes](/news/2019/announcing-1.3/helm-changes/)
|
||||
for a detailed summary of the option changes between release 1.2 and release 1.3.
|
||||
{{< /tip >}}
|
||||
|
||||
To customize Istio install using Helm, use the `--set <key>=<value>` option in Helm command to override one or more values. The set of supported keys is shown in the table below.
|
||||
|
||||
<!-- Run python scripts/tablegen.py to generate this table -->
|
||||
|
||||
<!-- AUTO-GENERATED-START -->
|
||||
|
|
|
|||
|
|
@ -13,8 +13,10 @@ The profiles provide customization of the Istio control plane and of the sidecar
|
|||
You can start with one of Istio’s built-in configuration profiles and then further customize the configuration for
|
||||
your specific needs. The following built-in configuration profiles are currently available:
|
||||
|
||||
1. **default**: enables components according to the default [Installation Options](/docs/reference/config/installation-options/)
|
||||
1. **default**: enables components according to the default settings of the
|
||||
[`IstioControlPlane` API](/docs/reference/config/istio.operator.v1alpha12.pb/)
|
||||
(recommend for production deployments).
|
||||
You can display the default setting by running the command `istioctl profile dump`.
|
||||
|
||||
1. **demo**: configuration designed to showcase Istio functionality with modest resource requirements.
|
||||
It is suitable to run the [Bookinfo](/docs/examples/bookinfo/) application and associated tasks.
|
||||
|
|
@ -31,53 +33,30 @@ your specific needs. The following built-in configuration profiles are currently
|
|||
1. **sds**: similar to the **default** profile, but also enables Istio's [SDS (secret discovery service)](/docs/tasks/security/auth-sds).
|
||||
This profile comes with additional authentication features enabled by default (Strict Mutual TLS).
|
||||
|
||||
1. **remote**: used for configuring remote clusters of a
|
||||
[multicluster mesh](/docs/setup/deployment-models/#multiple-clusters) with a
|
||||
[shared control plane](/docs/setup/install/multicluster/shared-vpn/) configuration.
|
||||
|
||||
The components marked as **X** are installed within each profile:
|
||||
|
||||
| | default | demo | minimal | sds |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| Core components | | | | | |
|
||||
| `istio-citadel` | X | X | | X |
|
||||
| `istio-egressgateway` | | X | | |
|
||||
| `istio-galley` | X | X | | X |
|
||||
| `istio-ingressgateway` | X | X | | X |
|
||||
| `istio-nodeagent` | | | | X |
|
||||
| `istio-pilot` | X | X | X | X |
|
||||
| `istio-policy` | X | X | | X |
|
||||
| `istio-sidecar-injector` | X | X | | X |
|
||||
| `istio-telemetry` | X | X | | X |
|
||||
| Addons | | | | | |
|
||||
| `grafana` | | X | | |
|
||||
| `istio-tracing` | | X | | |
|
||||
| `kiali` | | X | | |
|
||||
| `prometheus` | X | X | | X |
|
||||
| | default | demo | minimal | sds | remote
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| Core components | | | | | | |
|
||||
| `istio-citadel` | X | X | | X | X |
|
||||
| `istio-egressgateway` | | X | | | |
|
||||
| `istio-galley` | X | X | | X | |
|
||||
| `istio-ingressgateway` | X | X | | X | |
|
||||
| `istio-nodeagent` | | | | X | |
|
||||
| `istio-pilot` | X | X | X | X | |
|
||||
| `istio-policy` | X | X | | X | |
|
||||
| `istio-sidecar-injector` | X | X | | X | X |
|
||||
| `istio-telemetry` | X | X | | X | |
|
||||
| Addons | | | | | | |
|
||||
| `grafana` | | X | | | |
|
||||
| `istio-tracing` | | X | | | |
|
||||
| `kiali` | | X | | | |
|
||||
| `prometheus` | X | X | | X | |
|
||||
|
||||
To further customize Istio and install addons, you can add one or more `--set <key>=<value>` options in the
|
||||
`istioctl manifest` command that you use when installing Istio.
|
||||
The [Installation Options](/docs/reference/config/installation-options/) lists the complete set of supported
|
||||
installation key and value pairs.
|
||||
|
||||
## Multicluster profiles
|
||||
|
||||
Istio provides two additional built-in configuration profiles that are used exclusively for configuring a
|
||||
[multicluster deployment](/docs/setup/deployment-models/#multiple-clusters):
|
||||
|
||||
1. **remote**: used for configuring remote clusters of a
|
||||
multicluster mesh with a [shared control plane](/docs/setup/install/multicluster/shared-vpn/).
|
||||
|
||||
1. **multicluster-gateways**: used for configuring clusters of a
|
||||
multicluster mesh with [replicated control planes](/docs/setup/install/multicluster/gateways/).
|
||||
|
||||
The **remote** profile installs only two Istio core components:
|
||||
|
||||
1. `istio-citadel`
|
||||
|
||||
1. `istio-sidecar-injector`
|
||||
|
||||
The **multicluster-gateways** profile installs the same components as the Istio **default** configuration
|
||||
profile plus two additional components:
|
||||
|
||||
1. The `istio-egressgateway` core component.
|
||||
|
||||
1. The `coredns` addon.
|
||||
|
||||
Refer to the [multicluster installation instructions](/docs/setup/install/multicluster/) for more details.
|
||||
Refer to [customizing the configuration](/docs/setup/install/operator/#customizing-the-configuration) for details.
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ Cross-cluster communication occurs over Istio gateways of the respective cluster
|
|||
{{< /text >}}
|
||||
|
||||
For further details and customization options, refer to the
|
||||
[Installation with Istioctl](/docs/setup/install/kubernetes/) instructions.
|
||||
[installation instructions](/docs/setup/install/operator/).
|
||||
|
||||
## Setup DNS
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Istio control plane, Envoy can then form a mesh network across multiple clusters
|
|||
|
||||
* Two or more clusters running a supported Kubernetes version ({{< supported_kubernetes_versions >}}).
|
||||
|
||||
* The ability to deploy the [Istio control plane](/docs/setup/install/kubernetes/)
|
||||
* The ability to [deploy the Istio control plane](/docs/setup/install/operator/)
|
||||
on **one** of the clusters.
|
||||
|
||||
* A RFC1918 network, VPN, or an alternative more advanced network technique
|
||||
|
|
@ -46,7 +46,7 @@ manifests and Helm charts provided within the Istio repository.
|
|||
|
||||
## Deploy the local control plane
|
||||
|
||||
Install the [Istio control plane](/docs/setup/install/kubernetes/)
|
||||
[Install the Istio control plane](/docs/setup/install/operator/)
|
||||
on **one** Kubernetes cluster.
|
||||
|
||||
## Install the Istio remote
|
||||
|
|
|
|||
|
|
@ -229,13 +229,26 @@ line. For example, to disable the telemetry feature in a default configuration p
|
|||
$ istioctl manifest apply --set telemetry.enabled=false
|
||||
{{< /text >}}
|
||||
|
||||
Alternatively, a complete configuration can be specified in a YAML file and passed to
|
||||
Alternatively, the `IstioControlPlane` configuration can be specified in a YAML file and passed to
|
||||
`istioctl` using the `-f` option:
|
||||
|
||||
{{< text bash >}}
|
||||
$ istioctl manifest apply -f samples/pilot-k8s.yaml
|
||||
{{< /text >}}
|
||||
|
||||
{{< tip >}}
|
||||
For backwards compatibility, the previous [Helm installation options](/docs/reference/config/installation-options/)
|
||||
are also fully supported. To set them on the command line, prepend the option name with "`values.`".
|
||||
For example, the following command overrides the `pilot.traceSampling` Helm configuration option:
|
||||
|
||||
{{< text bash >}}
|
||||
$ istioctl manifest apply --set values.pilot.traceSampling=0.1
|
||||
{{< /text >}}
|
||||
|
||||
Helm values can also be set in an `IstioControlPlane` definition as described in
|
||||
[Customize Istio settings using the Helm API](#customize-istio-settings-using-the-helm-api), below.
|
||||
{{< /tip >}}
|
||||
|
||||
### Identify an Istio feature or component
|
||||
|
||||
The `IstioControlPlane` API groups control plane components by feature, as shown in the table below:
|
||||
|
|
|
|||
Loading…
Reference in New Issue