Ambient beta get started guide patch #14788

nauticalmike · 2024-03-26T02:25:13Z

Description

adjusting ambient getting started guide to include in-pod ztunnel log proxy status #14355

Reviewers

… proxy status

linux-foundation-easycla · 2024-03-26T02:25:16Z

The committers listed above are authorized under a signed CLA.

✅ login: nauticalmike / name: Michael Ac (ca132eb, ef0a43f, 502d6e1, efaba1f, 7eed0a1, 5ec4956, 34e8c60, df83fe2, d58395e, 1fcf26d, 17707aa, 45cfb8f, 60936fd, 80face7, c10c8a8, da215ba, 8cce10f, aa83868, 8dfddb1, 0c7c11b, adba565, c9975cf, 815e12a, c74a627)

istio-testing · 2024-03-26T02:25:24Z

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 · 2024-03-26T12:48:31Z

/ok-to-test

ericvn · 2024-03-26T17:44:53Z

make snips is used to generate the file from the index.md.

nauticalmike · 2024-03-26T17:56:52Z

make snips is used to generate the file from the index.md.

thanks Eric, I was using make gen but it was messing up my snips

nauticalmike · 2024-03-26T19:45:27Z

@ericvn what's the next step here?

content/en/docs/ops/ambient/getting-started/test.sh

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

content/en/docs/ops/ambient/getting-started/index.md

content/en/docs/ops/ambient/getting-started/test.sh

content/en/docs/ops/ambient/getting-started/snips.sh

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

nauticalmike · 2024-03-27T22:33:22Z

content/en/docs/ops/ambient/getting-started/test.sh

@@ -65,7 +65,7 @@ _verify_contains snip_verify_traffic_notsleep_to_productpage "$snip_verify_traff
 _verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"

 # test traffic after ambient mode is enabled
-_verify_contains snip_adding_your_application_to_the_ambient_mesh_3 "$snip_adding_your_application_to_the_ambient_mesh_3_out"
+_verify_contains snip_adding_your_application_to_the_ambient_mesh_3 "received netns, starting proxy"


@frankbu I decided to do the validation directly on the test script as the snips keeps on failing. I see someone did the same before here on line 77

test failed again... running out of ideas here...

VERIFY FAILED snip_adding_your_application_to_the_ambient_mesh_3 (timeout after 120s): received: "" expected: "received netns, starting proxy"

Might be worth troubleshooting by dropping the grep in that snip and just having it dump the logs, just to see what is being logged in the ztunnel pods.

thanks @dhawton I found that one, I tried several combinations to get that snippet of the doc in but the test keeps on failing for different reasons. The idea here is to show the logs after the ns labeling, but when I use the whole output like:

kubectl logs ds/ztunnel -n istio-system | grep inpod Found 3 pods, using pod/ztunnel-jrxln inpod_enabled: true inpod_uds: /var/run/ztunnel/ztunnel.sock inpod_port_reuse: true inpod_mark: 1337 2024-03-26T00:02:06.161802Z INFO ztunnel::inpod::workloadmanager: handling new stream 2024-03-26T00:02:06.162099Z INFO ztunnel::inpod::statemanager: pod received snapshot sent 2024-03-26T00:41:05.518194Z INFO ztunnel::inpod::statemanager: pod WorkloadUid("7ef61e18-725a-4726-84fa-05fc2a440879") received netns, starting proxy

the test _verify_like or _verify_contains doesn't match but I can see a similar print on the artifacts output, my last attempt just removed the snips.sh out reference and match the contains directly like:

_verify_contains snip_adding_your_application_to_the_ambient_mesh_3 "received netns, starting proxy"

but as you can see the output is empty

that's the thing, on my previous validations I was able to see an output like described above but one pod instead of 3 and obviously different time stamps and workloadid but neither the _verify_like or _verify_contains matched anything...

I can't see the output of the log really, I can only tell grep had no match... the received netns statement is ~2 months old, so it's in the commit of Istio that the docs is using atm. Wonder if it's not starting up, or hasn't finished initializing when the test is being run?

@dhawton here you can see even though I added back the snip ref it also doesn't match to anything. I'm going to try right now just 'grepping' the proxy string

nauticalmike · 2024-03-27T22:55:35Z

/retest

frankbu · 2024-03-28T13:30:49Z

content/en/docs/ops/ambient/getting-started/test.sh

@@ -62,10 +62,9 @@ _verify_contains snip_verify_traffic_sleep_to_ingress "$snip_verify_traffic_slee
 _verify_contains snip_verify_traffic_sleep_to_productpage "$snip_verify_traffic_sleep_to_productpage_out"
 _verify_contains snip_verify_traffic_notsleep_to_productpage "$snip_verify_traffic_notsleep_to_productpage_out"

-snip_adding_your_application_to_the_ambient_mesh_1
+_verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"


I'm not surprised it's failing now, since you're not calling snip_adding_your_application_to_the_ambient_mesh_2

Why didn't you change to the code I suggested in my previous comment? #14788 (review)

Suggested change

_verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"

_verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"

snip_adding_your_application_to_the_ambient_mesh_2

I'm not calling it because when I generate the snips there is no snip_adding_your_application_to_the_ambient_mesh_2 and that is because as pointed out before there is no need to validate this section:

{{< text syntax=bash snip_id=none >}} $ kubectl label namespace default istio.io/dataplane-mode=ambient {{< /text >}}

as I'm not referencing any output on the document.

Are you saying that even though in this case I should remove the snip_id=none let it generate the snip_adding_your_application_to_the_ambient_mesh_2 and just not call any validation from the test.sh?

I said that you don't need to validate the output of the snip, not that you don't need to call it. If you don't call the snip that adds the label, how could it possibly get labelled so that the following snips will work?

Just put it back to generate all the snips the way you had it previously and change the test to what I said yesterday.

_verify_same snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out" # test traffic after ambient mode is enabled snip_adding_your_application_to_the_ambient_mesh_2 _verify_like snip_adding_your_application_to_the_ambient_mesh_3 "$snip_adding_your_application_to_the_ambient_mesh_3_out" _verify_same snip_adding_your_application_to_the_ambient_mesh_4 "$snip_adding_your_application_to_the_ambient_mesh_4_out" _verify_same snip_adding_your_application_to_the_ambient_mesh_5 "$snip_adding_your_application_to_the_ambient_mesh_5_out" _verify_same snip_adding_your_application_to_the_ambient_mesh_6 "$snip_adding_your_application_to_the_ambient_mesh_6_out"

Either that, or disable the test (rename it to test-disable.sh) and I'll fix it in a followup.

@frankbu why 4 5 and 6 are _verify_same?
they are related to sections of the doc that I'm not modifying and the current version of the test does
_verify_contains here should I change those from your suggestion of _verify_same to _verify_contains?

_verify_same and _verify_contains will both work in these cases, but _verify_same is a better check since it really is checking that the output is "exactly the same as expected", which it is in this case. _verify_contains checks that the expected string is part of the output, which could include more text.

https://github.com/istio/istio.io/blob/master/tests/README.md#verify-functions

understood, I think I tested with that and succeed locally but failed here. I will send one like this and we'll see, thanks.

https://github.com/istio/istio.io/blob/master/tests/README.md#verify-functions

yeap, that's the one I have been using but I don't get consistent outputs when run here

nauticalmike · 2024-03-28T13:45:13Z

/retest

content/en/docs/ops/ambient/getting-started/test.sh

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

dhawton · 2024-03-28T15:53:11Z

/test doc.test.profile-default

dhawton · 2024-03-28T16:28:56Z

/cherry-pick release-1.21

istio-testing · 2024-03-28T16:30:18Z

@dhawton: #14788 failed to apply on top of branch "release-1.21":

Applying: adjusting ambient getting started guide to include in-pod ztunnel log proxy status
Applying: removing boilerplate reference
Applying: removing trailing whitespaces
Applying: removing whitespaces from snips
Using index info to reconstruct a base tree...
M	content/en/docs/ops/ambient/getting-started/snips.sh
Falling back to patching base and 3-way merge...
Auto-merging content/en/docs/ops/ambient/getting-started/snips.sh
CONFLICT (content): Merge conflict in content/en/docs/ops/ambient/getting-started/snips.sh
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0004 removing whitespaces from snips
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.21

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.

istio-testing · 2024-03-28T16:30:19Z

@dhawton: new issue created for failed cherrypick: #14801

In response to this:

/cherry-pick release-1.21

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.

* Sync #14788 into Chinese * improve * Apply suggestions from code review Co-authored-by: Michael <haifeng.yao@daocloud.io> Co-authored-by: Xiaopeng Han <hanxiaop8@outlook.com> --------- Co-authored-by: Michael <haifeng.yao@daocloud.io> Co-authored-by: Xiaopeng Han <hanxiaop8@outlook.com>

nauticalmike added 2 commits March 25, 2024 22:15

adjusting ambient getting started guide to include in-pod ztunnel log…

ef0a43f

… proxy status

Merge branch 'master' into ambient-beta-get-started-guide-patch

60936fd

nauticalmike requested a review from a team as a code owner March 26, 2024 02:25

istio-policy-bot added area/ambient kind/docs labels Mar 26, 2024

istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test labels Mar 26, 2024

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 Mar 26, 2024

nauticalmike added 3 commits March 26, 2024 08:58

removing boilerplate reference

ca132eb

removing trailing whitespaces

17707aa

removing whitespaces from snips

df83fe2

istio-testing added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 26, 2024

nauticalmike added 4 commits March 26, 2024 11:39

adjusting testing snips

efaba1f

adjusting testing snips for output

5ec4956

adjusting testing snips for output

0c7c11b

fixing missing validation

45cfb8f

nauticalmike added 3 commits March 26, 2024 14:04

fixing snips

34e8c60

fixing snips

da215ba

fixing snips

1fcf26d

frankbu reviewed Mar 26, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/test.sh Outdated Show resolved Hide resolved

Update content/en/docs/ops/ambient/getting-started/test.sh

aa83868

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

frankbu reviewed Mar 27, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/index.md Show resolved Hide resolved

frankbu reviewed Mar 27, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/index.md Outdated Show resolved Hide resolved

frankbu reviewed Mar 27, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/test.sh Outdated Show resolved Hide resolved

frankbu reviewed Mar 27, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/snips.sh Show resolved Hide resolved

ericvn mentioned this pull request Mar 27, 2024

Automator: update istio@ test reference #14775

Closed

nauticalmike and others added 4 commits March 27, 2024 14:34

Update content/en/docs/ops/ambient/getting-started/index.md

7eed0a1

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

fixing tests

80face7

fixing tests

c10c8a8

fixing tests

8dfddb1

nauticalmike commented Mar 27, 2024

View reviewed changes

nauticalmike added 3 commits March 27, 2024 21:10

fixing tests

8cce10f

fixing tests

c9975cf

fixing tests

815e12a

frankbu reviewed Mar 28, 2024

View reviewed changes

fixing tests

adba565

frankbu reviewed Mar 28, 2024

View reviewed changes

content/en/docs/ops/ambient/getting-started/test.sh Outdated Show resolved Hide resolved

Update content/en/docs/ops/ambient/getting-started/test.sh

c74a627

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

frankbu approved these changes Mar 28, 2024

View reviewed changes

istio-testing merged commit 523307b into istio:master Mar 28, 2024
12 checks passed

wilsonwu added a commit to wilsonwu/istio.io that referenced this pull request Mar 28, 2024

Sync istio#14788 into Chinese

4bc0582

wilsonwu mentioned this pull request Mar 28, 2024

[zh] Sync #14788 into Chinese #14800

Merged

11 tasks

istio-testing mentioned this pull request Mar 28, 2024

[release-1.21] Ambient beta get started guide patch #14801

Closed

This was referenced Mar 28, 2024

update ambient get started guide for the inpod cni stuff once merged #14355

Closed

Ambient beta get started guide patch #14805

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ambient beta get started guide patch #14788

Ambient beta get started guide patch #14788

nauticalmike commented Mar 26, 2024 •

edited

linux-foundation-easycla bot commented Mar 26, 2024 •

edited

istio-testing commented Mar 26, 2024

ericvn commented Mar 26, 2024

ericvn commented Mar 26, 2024

nauticalmike commented Mar 26, 2024

nauticalmike commented Mar 26, 2024

nauticalmike Mar 27, 2024

nauticalmike Mar 27, 2024

dhawton Mar 28, 2024 •

edited

dhawton Mar 28, 2024

nauticalmike Mar 28, 2024

nauticalmike Mar 28, 2024

dhawton Mar 28, 2024

nauticalmike Mar 28, 2024 •

edited

nauticalmike commented Mar 27, 2024

frankbu Mar 28, 2024

nauticalmike Mar 28, 2024

frankbu Mar 28, 2024

nauticalmike Mar 28, 2024 •

edited

frankbu Mar 28, 2024

frankbu Mar 28, 2024

nauticalmike Mar 28, 2024

nauticalmike Mar 28, 2024

nauticalmike commented Mar 28, 2024

dhawton commented Mar 28, 2024

dhawton commented Mar 28, 2024

istio-testing commented Mar 28, 2024

istio-testing commented Mar 28, 2024

	_verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"
	_verify_contains snip_adding_your_application_to_the_ambient_mesh_1 "$snip_adding_your_application_to_the_ambient_mesh_1_out"
	snip_adding_your_application_to_the_ambient_mesh_2

Ambient beta get started guide patch #14788

Ambient beta get started guide patch #14788

Conversation

nauticalmike commented Mar 26, 2024 • edited

Description

Reviewers

linux-foundation-easycla bot commented Mar 26, 2024 • edited

istio-testing commented Mar 26, 2024

ericvn commented Mar 26, 2024

ericvn commented Mar 26, 2024

nauticalmike commented Mar 26, 2024

nauticalmike commented Mar 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhawton Mar 28, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nauticalmike Mar 28, 2024 • edited

Choose a reason for hiding this comment

nauticalmike commented Mar 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nauticalmike Mar 28, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nauticalmike commented Mar 28, 2024

dhawton commented Mar 28, 2024

dhawton commented Mar 28, 2024

istio-testing commented Mar 28, 2024

istio-testing commented Mar 28, 2024

nauticalmike commented Mar 26, 2024 •

edited

linux-foundation-easycla bot commented Mar 26, 2024 •

edited

dhawton Mar 28, 2024 •

edited

nauticalmike Mar 28, 2024 •

edited

nauticalmike Mar 28, 2024 •

edited