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.

Sign up for GitHub

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

Add to gateway documentation to clarify use of non-standard ports. #2732

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

Add to gateway documentation to clarify use of non-standard ports. #2732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions networking/v1alpha3/gateway.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions networking/v1alpha3/gateway.pb.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 12 additions & 3 deletions networking/v1alpha3/gateway.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ import "google/api/field_behavior.proto";
// on these ports, it is the responsibility of the user to ensure that
// external traffic to these ports are allowed into the mesh.
//
// Ports 9443 and 2379 must exist on the ingress-gateway, `my-gateway-controller` in the example below.
Copy link
Member

Choose a reason for hiding this comment

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

Why not mention 9080?

Copy link
Member

Choose a reason for hiding this comment

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

which I saw also in the gateway example below.

Copy link
Author

Choose a reason for hiding this comment

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

Hi, yes there could be more, but at the moment I'm trying to figure out how the process works. it says I need to apply a release-notes-none label and I haven't figure out how to do that!!

Copy link
Author

Choose a reason for hiding this comment

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

Hi @linsun I cant figure out how to edit this PR to add the release-notes-none label. In addition I set it to "draft" and now see no way to remove that label in the webpage.
https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-a-label
Does not seem to help as in my own fork, I don't see my PR.

Using gh I dont have access.

? Which repository should be the default? istio/api
✓ Set istio/api as the default repository for the current directory
gh pr list
gh pr edit
? What would you like to edit? Labels
? Labels do-not-merge/work-in-progress, ok-to-test, release-notes-none, size/M
? Submit? Yes
Message: jhuttley-F5-com does not have the correct permissions to execute AddLabelsToLabelable, Locations: [{Line:1 Column:54}]

Do I have to cancel the PR and start again? --John

Copy link

Choose a reason for hiding this comment

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

Hi, yes there could be more, but at the moment I'm trying to figure out how the process works. it says I need to apply a release-notes-none label and I haven't figure out how to do that!!

I believe only istio members, and maybe its maintainers, can apply the label. A secondary comment is if you look closely, the release-notes_api test is not required in this repo. As such, a failure in that test would not prevent a PR from being merged.

Copy link

Choose a reason for hiding this comment

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

Thanks for the contribution. Since this change is clarifying documentation and that usually doesn't have a release note, I'll add the release-noes-none label.

// By default only ports 80 and 443 (http) are configured.
// The available ports are shown in the Service for the ingress-gateway, in the istio-system namespace.
// If a port requested by a `Gateway` resource does not exist on the ingress-gateway,
// `istioctl analyze` will report "The gateway refers to a port that is not exposed on the workload".
//
// {{<tabset category-name="example">}}
// {{<tab name="v1alpha3" category-value="v1alpha3">}}
// ```yaml
Expand Down Expand Up @@ -147,11 +153,14 @@ import "google/api/field_behavior.proto";
// {{</tab>}}
// {{</tabset>}}
//
// The Gateway specification above describes the L4-L6 properties of a load
// balancer. A `VirtualService` can then be bound to a gateway to control
// The `Gateway` specification above describes the L4-L6 properties of a load
// balancer. A `VirtualService` can then be bound to a `Gateway` to control
// the forwarding of traffic arriving at a particular host or gateway port.
//
// For example, the following VirtualService splits traffic for
// For a non-http `Gateway` port, you must create the `VirtualService` resource first, then the `Gateway`.
// If you attempt to create the `Gateway` first, it will fail. istiod will log "must have more than 0 chains in listener".
//
// The following VirtualService splits traffic for
// `https://uk.bookinfo.com/reviews`, `https://eu.bookinfo.com/reviews`,
// `http://uk.bookinfo.com:9080/reviews`,
// `http://eu.bookinfo.com:9080/reviews` into two versions (prod and qa) of
Expand Down
15 changes: 12 additions & 3 deletions networking/v1beta1/gateway.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 12 additions & 3 deletions networking/v1beta1/gateway.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ import "google/api/field_behavior.proto";
// on these ports, it is the responsibility of the user to ensure that
// external traffic to these ports are allowed into the mesh.
//
// Ports 9443 and 2379 must exist on the ingress-gateway, `my-gateway-controller` in the example below.
// By default only ports 80 and 443 (http) are configured.
// The available ports are shown in the Service for the ingress-gateway, in the istio-system namespace.
// If a port requested by a `Gateway` resource does not exist on the ingress-gateway,
// `istioctl analyze` will report "The gateway refers to a port that is not exposed on the workload".
//
// {{<tabset category-name="example">}}
// {{<tab name="v1alpha3" category-value="v1alpha3">}}
// ```yaml
Expand Down Expand Up @@ -148,11 +154,14 @@ import "google/api/field_behavior.proto";
// {{</tab>}}
// {{</tabset>}}
//
// The Gateway specification above describes the L4-L6 properties of a load
// balancer. A `VirtualService` can then be bound to a gateway to control
// The `Gateway` specification above describes the L4-L6 properties of a load
// balancer. A `VirtualService` can then be bound to a `Gateway` to control
// the forwarding of traffic arriving at a particular host or gateway port.
//
// For example, the following VirtualService splits traffic for
// For a non-http `Gateway` port, you must create the `VirtualService` resource first, then the `Gateway`.
// If you attempt to create the `Gateway` first, it will fail. istiod will log "must have more than 0 chains in listener".
//
// The following VirtualService splits traffic for
// `https://uk.bookinfo.com/reviews`, `https://eu.bookinfo.com/reviews`,
// `http://uk.bookinfo.com:9080/reviews`,
// `http://eu.bookinfo.com:9080/reviews` into two versions (prod and qa) of
Expand Down