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

46223 Add missing step to apply destination rules after running virtual services #13655

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

Conversation

bedla
Copy link

@bedla bedla commented Jul 28, 2023

Hi,
This is PR for #13664 ... see detials there.
Thx
Ivos

@bedla bedla requested a review from a team as a code owner July 28, 2023 12:42
@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been awhile since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, about our style guidelines,
    and about all the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be
    built as a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the Status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point
    to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    status section of the page. Click on the Details link to get a list of the problems with your PR.
    Fix those problems and push an update to your PR. This will automatically rerun the tests and
    hopefully this time everything will be perfect.

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 28, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: bedla / name: Ivo Šmíd (00e7d9c)

@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test labels Jul 28, 2023
@istio-testing
Copy link
Contributor

Hi @bedla. 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.

@@ -59,6 +59,12 @@ Run the following command to apply virtual services that will route all traffic
$ kubectl apply -f @samples/bookinfo/networking/virtual-service-all-v1.yaml@
{{< /text >}}

And to apply `DestinationRule` items run following command.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This isn't needed because the warning on line 46 tells the user to make sure it's already done.

If you haven't already, follow the instructions in [define the service versions](/docs/examples/bookinfo/#define-the-service-versions).

Copy link
Author

Choose a reason for hiding this comment

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

ahh, I see. It is kind of hidden.

I executed command from section https://istio.io/latest/docs/setup/getting-started/#bookinfo
image

And did not clicked to link (because it looks like that it is not necessary) that goes to https://istio.io/latest/docs/examples/bookinfo/ ... let me update the text, to make it more explicit.

Copy link
Author

Choose a reason for hiding this comment

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

I have force pushed changed, what do you think?

@bedla bedla force-pushed the bug/46223-destinationrules branch from 59a01ba to 00e7d9c Compare July 28, 2023 13:44
@@ -110,7 +110,7 @@ Follow these steps to get started with Istio:

## Deploy the sample application {#bookinfo}

1. Deploy the [`Bookinfo` sample application](/docs/examples/bookinfo/):
1. Follow steps in the page [`Bookinfo` sample application](/docs/examples/bookinfo/) to deploy sample application:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we want to change the getting started page to tell users to go to another document to do things. The getting started doc is supposed to be a simple, self contained, set of instructions to make it easy for users to start looking at Istio.

I see why the current request-routing instructions are a little confusing (hidden). My suggestion would be to remove the warning on line 46 and put the warning under each tab (Istio APIs and Gateway API) instead.

Then you can change the wording under the Istio APIs tab to make it clear that it's asking you to create the destination rules:

If you haven’t already applied destination rules, follow the instructions in [define the service versions](/docs/examples/bookinfo/#define-the-service-versions).

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/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 Jul 29, 2023
@bedla bedla marked this pull request as draft September 18, 2023 19:09
@istio-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Sep 18, 2023
Copy link
Contributor

@craigbox craigbox left a comment

Choose a reason for hiding this comment

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

Please update the PR with Frank's suggestions.
(I definitely think the problem is on the request-routing page, not the getting started page.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants