Skip to content

Commit

Permalink
Update sidecar getting started guide (#15436)
Browse files Browse the repository at this point in the history
* Update sidecar getting started guide.

* Fix tests

* Apply suggestions from code review

Co-authored-by: Faseela K <[email protected]>

* Fix gencheck

---------

Co-authored-by: Faseela K <[email protected]>
  • Loading branch information
craigbox and kfaseela authored Jul 30, 2024
1 parent b5b97e5 commit a13a2bb
Show file tree
Hide file tree
Showing 23 changed files with 443 additions and 478 deletions.
2 changes: 1 addition & 1 deletion content/en/blog/2024/v1-apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ This is the full list of supported API versions:
| Telemetry | [Telemetry](/docs/reference/config/telemetry/) | `v1`, `v1alpha1` |
| Extension | [Wasm Plugin](/docs/reference/config/proxy_extensions/wasm-plugin/) | `v1alpha1` |

Istio can also be configured [using the Kubernetes Gateway API](/docs/setup/additional-setup/getting-started/).
Istio can also be configured [using the Kubernetes Gateway API](/docs/setup/getting-started/).

## Using the `v1` Istio APIs

Expand Down
2 changes: 1 addition & 1 deletion content/en/boilerplates/trace-generation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---
To see trace data, you must send requests to your service. The number of requests depends on Istio's sampling rate and can be configured using the [Telemetry API](/docs/tasks/observability/telemetry/). With the default sampling rate of 1%, you need to send at least 100 requests before the first trace is visible.
To send a 100 requests to the `productpage` service, use the following command:
To send 100 requests to the `productpage` service, use the following command:

{{< text bash >}}
$ for i in $(seq 1 100); do curl -s -o /dev/null "http://$GATEWAY_URL/productpage"; done
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/ops/diagnostic-tools/istioctl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ We recommend you use an `istioctl` version that is the same version as your Isti
Using matching versions helps avoid unforeseen issues.

{{< tip >}}
If you have already [downloaded the Istio release](/docs/setup/getting-started/#download), you should
If you have already [downloaded the Istio release](/docs/setup/additional-setup/download-istio-release/), you should
already have `istioctl` and do not need to install it again.
{{< /tip >}}

Expand Down Expand Up @@ -172,7 +172,7 @@ To enable `istioctl` completion on your system, follow the steps for your prefer

{{< warning >}}
You will need to download the full Istio release containing the auto-completion files (in the `/tools` directory).
If you haven't already done so, [download the full release](/docs/setup/getting-started/#download) now.
If you haven't already done so, [download the full release](/docs/setup/additional-setup/download-istio-release/) now.
{{< /warning >}}

{{< tabset category-name="profile" >}}
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/ops/integrations/spire/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ A ClusterSPIFFEID must be applied prior to installing Istio in order for the Ing

The example ClusterSPIFFEID enables automatic workload registration for all workloads with the `spiffe.io/spire-managed-identity: "true"` label. For pods with this label, the values specified in the `spiffeIDTemplate` will be extracted to form the SPIFFE ID.

1. [Download the Istio release](/docs/setup/getting-started/#download).
1. [Download the Istio release](/docs/setup/additional-setup/download-istio-release/).

1. Create the Istio configuration with custom patches for the Ingress-gateway and istio-proxy. The Ingress Gateway component includes the `spiffe.io/spire-managed-identity: "true"` label.

Expand Down Expand Up @@ -194,7 +194,7 @@ Note that `SPIRE Controller Manager` is used in the [quick start](#option-1-quic

### Option 2: Configuration for Manual Workload Registration with SPIRE

1. [Download the Istio release](/docs/setup/getting-started/#download).
1. [Download the Istio release](/docs/setup/additional-setup/download-istio-release/).

1. After [deploying SPIRE](#install-spire) into your environment, and verifying that all deployments are in `Ready` state, configure Istio with custom patches for the Ingress-gateway as well as for istio-proxy.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test: n/a

Before you begin, check the following prerequisites:

1. [Download the Istio release](/docs/setup/getting-started/#download).
1. [Download the Istio release](/docs/setup/additional-setup/download-istio-release/).
1. Perform any necessary [platform-specific setup](/docs/setup/platform-setup/).
1. Check the [Requirements for Pods and Services](/docs/ops/deployment/application-requirements/).
1. [Usage of helm for Istio installation](/docs/setup/install/helm).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test: n/a

Before you begin, check the following prerequisites:

1. [Download the Istio release](/docs/setup/getting-started/#download).
1. [Download the Istio release](/docs/setup/additional-setup/download-istio-release/).
1. Perform any necessary [platform-specific setup](/docs/setup/platform-setup/).
1. Check the [Requirements for Pods and Services](/docs/ops/deployment/application-requirements/).

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Download the Istio release
description: Get the files required to install and explore Istio.
weight: 30
keywords: [profiles,install,release,istioctl]
owner: istio/wg-environments-maintainers
test: n/a
---

Each Istio release includes a _release archive_ which contains:

- the [`istioctl`](/docs/ops/diagnostic-tools/istioctl/) binary
- [installation profiles](/docs/setup/additional-setup/config-profiles/) and [Helm charts](/docs/setup/install/helm)
- samples, including the [Bookinfo](/docs/examples/bookinfo/) application

A release archive is built for each supported processor architecture and operating system.

## Download Istio {#download}

1. Go to the [Istio release]({{< istio_release_url >}}) page to
download the installation file for your OS, or download and
extract the latest release automatically (Linux or macOS):

{{< text bash >}}
$ curl -L https://istio.io/downloadIstio | sh -
{{< /text >}}

{{< tip >}}
The command above downloads the latest release (numerically) of Istio.
You can pass variables on the command line to download a specific version
or to override the processor architecture.
For example, to download Istio {{< istio_full_version >}} for the x86_64 architecture,
run:

{{< text bash >}}
$ curl -L https://istio.io/downloadIstio | ISTIO_VERSION={{< istio_full_version >}} TARGET_ARCH=x86_64 sh -
{{< /text >}}

{{< /tip >}}

1. Move to the Istio package directory. For example, if the package is
`istio-{{< istio_full_version >}}`:

{{< text syntax=bash snip_id=none >}}
$ cd istio-{{< istio_full_version >}}
{{< /text >}}

The installation directory contains:

- Sample applications in `samples/`
- The [`istioctl`](/docs/reference/commands/istioctl) client binary in the
`bin/` directory.

1. Add the `istioctl` client to your path (Linux or macOS):

{{< text bash >}}
$ export PATH=$PWD/bin:$PATH
{{< /text >}}
Loading

0 comments on commit a13a2bb

Please sign in to comment.