Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

quick guide on how to migrate from sidecars to ambient #14894

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nauticalmike
Copy link
Contributor

@nauticalmike nauticalmike commented Apr 17, 2024

Description

quick guide on how to migrate from sidecars to ambient

cc. @bleggett

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@nauticalmike nauticalmike requested a review from a team as a code owner April 17, 2024 14:40
@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 17, 2024
@istio-testing
Copy link
Contributor

Hi @nauticalmike. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ericvn
Copy link
Contributor

ericvn commented Apr 17, 2024

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Apr 17, 2024
---
title: Migrating from Sidecars to Ambient
description: How to migrate existing sidecar topology to Ambient
weight: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this Migration doc to really be the first doc in the list?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably not. If we do want to have this doc, it should be alpha, and not part of ambient beta.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted, we need to update the weight to reflect the correct position on the page. Should it be after User Guides (so a number greater than 15 and less than 20, or should this be under User Guides. I think I favor not being a User Guide.

@istio-testing
Copy link
Contributor

@nauticalmike: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
lint_istio.io 9296bdf link true /test lint

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@linsun
Copy link
Member

linsun commented Apr 17, 2024

cc @kfaseela who asked me about this before

Copy link
Contributor

@ericvn ericvn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial pass. Note that the Ambient doc location was changed in a PR so this document will need to move as well.

@@ -0,0 +1,333 @@
---
title: Migrating from Sidecars to Ambient
description: How to migrate existing sidecar topology to Ambient
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We haven't been capitalizing ambient

Suggested change
description: How to migrate existing sidecar topology to Ambient
description: How to migrate existing sidecar topology to ambient

---
title: Migrating from Sidecars to Ambient
description: How to migrate existing sidecar topology to Ambient
weight: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted, we need to update the weight to reflect the correct position on the page. Should it be after User Guides (so a number greater than 15 and less than 20, or should this be under User Guides. I think I favor not being a User Guide.

1. [Adding your application to ambient](#addtoambient)

## Download and install {#download}
1. Install [kind](https://kind.sigs.k8s.io/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Install [kind](https://kind.sigs.k8s.io/)
1. Install [kind](https://kind.sigs.k8s.io/).

{{< /text >}}

### Determining the ingress IP and ports

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this works for me. I believe I needed to install metallb in the past, but maybe I am wrong. Need to investigate this some more. Maybe we can simply use the curls as is done after migrating to ambient mode.

***

### K8s Gateway API

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have some text in this section?


### Disable sidecar injection {#disable}

Now that we have enabled Ambient mode, we need to remove the sidecar injection label in the namespace:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Now that we have enabled Ambient mode, we need to remove the sidecar injection label in the namespace:
Now that we have enabled ambient mode, we need to remove the sidecar injection label in the namespace:


## Adding your application to the ambient mesh {#addtoambient}

Ambient mesh data plane relies on the ztunnel DaemonSet to redirect traffic. Before we label the namespace to be part of an ambient mesh, check the ztunnel pods to make sure they are on a healthy state:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Ambient mesh data plane relies on the ztunnel DaemonSet to redirect traffic. Before we label the namespace to be part of an ambient mesh, check the ztunnel pods to make sure they are on a healthy state:
The ambient mesh data plane relies on the ztunnel DaemonSet to redirect traffic. Before we label the namespace to be part of an ambient mesh, check the ztunnel pods to make sure they are on a healthy state:

Copy link
Member

@kfaseela kfaseela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we have moved ambient docs outside ops, probably this file needs to be moved too

@craigbox
Copy link
Contributor

@linsun
Copy link
Member

linsun commented Apr 30, 2024

/hold

I don't think we should merge this doc for 1.22, as it doesn't work for waypoint. Might be working for 1.21 but for 1.22, sidecars aren't aware of waypoints thus this won't work.

Again this was decided by TOC to be out of scope for 1.22 - I'd recommend us focus on must items for 1.22 first for the remaining 2 weeks before 1.22 ships.

@linsun linsun added the do-not-merge/hold Block automatic merging of a PR. label Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ambient do-not-merge/hold Block automatic merging of a PR. kind/docs ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants