docs about usage of internal services in an "api-gateway" access model#3597
Conversation
|
Hi @lenalebt. Thanks for your PR. I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
| ## Using internal services and `"httpProtocol": "Redirected"` | ||
|
|
||
| Using the above approach, services will be available using two entrypoints into the cluster: | ||
| The original ones provided by KNative Serving (`search-service.default.example.com` and `login-service.default.example.com`), |
There was a problem hiding this comment.
| The original ones provided by KNative Serving (`search-service.default.example.com` and `login-service.default.example.com`), | |
| The original ones provided by Knative Serving (`search-service.default.example.com` and `login-service.default.example.com`), |
I think we use Knative instead of KNative so it should be consistent.
| metadata: | ||
| name: search-service | ||
| namespace: default | ||
| annotations: |
There was a problem hiding this comment.
I think visibility setting is not annotations but labels - https://knative.dev/docs/serving/cluster-local-route/
| metadata: | ||
| name: login-service | ||
| namespace: default | ||
| annotations: |
There was a problem hiding this comment.
Same here, it should be labels?
| Have a look at | ||
|
|
||
| ``` | ||
| kubectl apply --filename docs/serving/samples/knative-routing-go/sample-internal.yaml |
There was a problem hiding this comment.
Before applying this yaml, we need to replace the images in sample-internal.yaml by perl -pi -e "s@github.com/knative/docs/docs/serving/samples@${REPO}@g" docs/serving/samples/knative-routing-go/sample-internal.yaml?
I think we should either add sample-internal.yaml in Setup section above or to run command kubectl label kservice search-service login-service networking.knative.dev/visibility=cluster-local instead of kubectl apply
There was a problem hiding this comment.
I like the kubectl label kservice search-service login-service networking.knative.dev/visibility=cluster-local approach. Was not really happy with duplicating the file anyways.
|
/ok-to-test |
|
Thanks @nak3 for the review |
|
Thank you for the review! I applied your suggestions, and do really like them better. |
nak3
left a comment
There was a problem hiding this comment.
Thank you so much! Looks good to me except for one more small fix. Let's wait for docs team's another review.
|
|
||
| To make sure your service can only be reached via the manually created | ||
| VirtualService, you can add the label `networking.knative.dev/visibility: cluster-local` | ||
| to the KNative Service definitions, and route traffic over |
There was a problem hiding this comment.
| to the KNative Service definitions, and route traffic over | |
| to the Knative Service definitions, and route traffic over |
One more KNative.
There was a problem hiding this comment.
Sorry, I totally overread this one. Thanks for pointing me to it :)
|
/lgtm |
|
@lenalebt thanks for your contribution! If you're interested in getting more involved, join us in the Knative Slack at https://slack.knative.dev/! Message me and I can help point you in the right direction! :) |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: nak3, omerbensaadon The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/ok-to-test |
* change name for menu item for preview (#3533) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Added detail per issue #3425 (#3514) * Update knative/community files (#3553) Signed-off-by: Knative Automation <automation@knative.team> * tracing cm fix (#3506) * remove unnecessary requrirements to do a release (#3563) Signed-off-by: Carlos Santana <csantana23@gmail.com> * #3543 fix link (#3567) * Replace xip.io with sslip.io (#3574) * Update actions (#3535) Signed-off-by: Knative Automation <automation@knative.team> * Update common github actions (#3552) Signed-off-by: Knative Automation <automation@knative.team> * upgrade to latest dependencies (#3505) bumping knative.dev/hack 88c69cd...93ad912: > 93ad912 Print java and mvn version (# 65) > 86f9adc Fix default codegen pkg dir (# 67) Signed-off-by: Knative Automation <automation@knative.team> * Remove responsive-revision-gc config (#3545) Since knative/serving#10084 deleted old GC and started using responsive GC by default, `responsive-revision-gc` in `config-feature` is not used at all. This patch removes the configuration `responsive-revision-gc` in `config-feature` configmap. * Fixes #3117 and broken links (#3569) * Fix #3117 and broken links * Fix #3117 and broken links * remove spec folder and redirect page and update links * remove conflicts * Update shortcodes.md (#3550) minor grammar. * 💄 slight change to ordered delivery guarantees (#3536) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Add knative-release-leads to OWNERS (#3586) * add approvers ux (#3587) * Update the default value (#3530) * Adding notes on KafkaSource usage (#3596) * Adding some Kafka note for use-cases Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * changing the description Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Update actions (#3581) Signed-off-by: Knative Automation <automation@knative.team> * Remove python pycache (#3594) * Use correct setting in ClusterIssue setting (#3595) The doc uses ClusterIssuer `letsencrypt-http01-issuer` but the configuration uses `letsencrypt-issuer` so it is confusable. Actual report is #3560. So this patch changes the ClusterIssuer name to `letsencrypt-http01-issuer` which is used in this doc section. Fix #3560 * fix broken link #3568 #3577 (#3579) * fix Netlify build * Added Snippets folder and hidden Beta Contributor guide * Update docs/eventing/event-registry.md Co-authored-by: Carlos Santana <csantana23@gmail.com> * whitespace * more whitespace * removing this bit because linting is killing me * ok really the last one * Updating to latest API version of Strimzi. v1beta1 is now gone 🔥 (#3603) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * 📓 adding a note to not consume records of the kafkachannel's topic... (#3615) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * fix broken link in kogito example (#3602) * docs about usage of internal services in an "api-gateway" access model (#3597) Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> * api specs for v0.23 (#3619) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Update serving/_index.md with network layer option (#3585) * Update _index.md [#3117] Add ref for contour * Update docs/serving/_index.md Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Omer B <obensaadon@vmware.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> * Fix typos in the sample yaml file (#3616) * EventType is not yet part of the v1 eventing API (#3576) * Remaining changes from now closed PRs Co-authored-by: Carlos Santana <csantana23@gmail.com> Co-authored-by: RichardJJG <rijohnson@vmware.com> Co-authored-by: knative-automation <automation@knative.team> Co-authored-by: Shashankft9 <48708039+Shashankft9@users.noreply.github.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Benjamin Tan Wei Hao <benjamintanweihao@gmail.com> Co-authored-by: Kenjiro Nakayama <nakayamakenjiro@gmail.com> Co-authored-by: Jonathan Johnson <jonathan.johnson@dijure.com> Co-authored-by: Matthias Wessendorf <mwessend@redhat.com> Co-authored-by: Evan Anderson <evana@vmware.com> Co-authored-by: RichieEscarez <rescarez@google.com> Co-authored-by: NovaHe <heqianfly@gmail.com> Co-authored-by: Kevin Marquardsen <mr.kmarq@gmail.com> Co-authored-by: Lena Brüder <oss@lena-brueder.de> Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> Co-authored-by: Sameer Vohra <vsameer@vmware.com> Co-authored-by: Mahdi K. Fard <xclud@users.noreply.github.com>
|
@omerbensaadon Thanks for the nice invitation :). I guess I'll add PRs on-the-go whenever I see something where I do think I can add something. Thanks to @nak3 - it was mostly him pointing me in the right direction here, really thankful for the nice atmosphere! |
* change name for menu item for preview (knative#3533) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Added detail per issue knative#3425 (knative#3514) * Update knative/community files (knative#3553) Signed-off-by: Knative Automation <automation@knative.team> * tracing cm fix (knative#3506) * remove unnecessary requrirements to do a release (knative#3563) Signed-off-by: Carlos Santana <csantana23@gmail.com> * knative#3543 fix link (knative#3567) * Replace xip.io with sslip.io (knative#3574) * Update actions (knative#3535) Signed-off-by: Knative Automation <automation@knative.team> * Update common github actions (knative#3552) Signed-off-by: Knative Automation <automation@knative.team> * upgrade to latest dependencies (knative#3505) bumping knative.dev/hack 88c69cd...93ad912: > 93ad912 Print java and mvn version (# 65) > 86f9adc Fix default codegen pkg dir (# 67) Signed-off-by: Knative Automation <automation@knative.team> * Remove responsive-revision-gc config (knative#3545) Since knative/serving#10084 deleted old GC and started using responsive GC by default, `responsive-revision-gc` in `config-feature` is not used at all. This patch removes the configuration `responsive-revision-gc` in `config-feature` configmap. * Fixes knative#3117 and broken links (knative#3569) * Fix knative#3117 and broken links * Fix knative#3117 and broken links * remove spec folder and redirect page and update links * remove conflicts * Update shortcodes.md (knative#3550) minor grammar. * 💄 slight change to ordered delivery guarantees (knative#3536) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Add knative-release-leads to OWNERS (knative#3586) * add approvers ux (knative#3587) * Update the default value (knative#3530) * Adding notes on KafkaSource usage (knative#3596) * Adding some Kafka note for use-cases Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * changing the description Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Update actions (knative#3581) Signed-off-by: Knative Automation <automation@knative.team> * Remove python pycache (knative#3594) * Use correct setting in ClusterIssue setting (knative#3595) The doc uses ClusterIssuer `letsencrypt-http01-issuer` but the configuration uses `letsencrypt-issuer` so it is confusable. Actual report is knative#3560. So this patch changes the ClusterIssuer name to `letsencrypt-http01-issuer` which is used in this doc section. Fix knative#3560 * fix broken link knative#3568 knative#3577 (knative#3579) * fix Netlify build * Added Snippets folder and hidden Beta Contributor guide * Update docs/eventing/event-registry.md Co-authored-by: Carlos Santana <csantana23@gmail.com> * whitespace * more whitespace * removing this bit because linting is killing me * ok really the last one * Updating to latest API version of Strimzi. v1beta1 is now gone 🔥 (knative#3603) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * 📓 adding a note to not consume records of the kafkachannel's topic... (knative#3615) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * fix broken link in kogito example (knative#3602) * docs about usage of internal services in an "api-gateway" access model (knative#3597) Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> * api specs for v0.23 (knative#3619) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Update serving/_index.md with network layer option (knative#3585) * Update _index.md [knative#3117] Add ref for contour * Update docs/serving/_index.md Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Omer B <obensaadon@vmware.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> * Fix typos in the sample yaml file (knative#3616) * EventType is not yet part of the v1 eventing API (knative#3576) * Remaining changes from now closed PRs Co-authored-by: Carlos Santana <csantana23@gmail.com> Co-authored-by: RichardJJG <rijohnson@vmware.com> Co-authored-by: knative-automation <automation@knative.team> Co-authored-by: Shashankft9 <48708039+Shashankft9@users.noreply.github.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Benjamin Tan Wei Hao <benjamintanweihao@gmail.com> Co-authored-by: Kenjiro Nakayama <nakayamakenjiro@gmail.com> Co-authored-by: Jonathan Johnson <jonathan.johnson@dijure.com> Co-authored-by: Matthias Wessendorf <mwessend@redhat.com> Co-authored-by: Evan Anderson <evana@vmware.com> Co-authored-by: RichieEscarez <rescarez@google.com> Co-authored-by: NovaHe <heqianfly@gmail.com> Co-authored-by: Kevin Marquardsen <mr.kmarq@gmail.com> Co-authored-by: Lena Brüder <oss@lena-brueder.de> Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> Co-authored-by: Sameer Vohra <vsameer@vmware.com> Co-authored-by: Mahdi K. Fard <xclud@users.noreply.github.com>
* change name for menu item for preview (knative#3533) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Added detail per issue knative#3425 (knative#3514) * Update knative/community files (knative#3553) Signed-off-by: Knative Automation <automation@knative.team> * tracing cm fix (knative#3506) * remove unnecessary requrirements to do a release (knative#3563) Signed-off-by: Carlos Santana <csantana23@gmail.com> * knative#3543 fix link (knative#3567) * Replace xip.io with sslip.io (knative#3574) * Update actions (knative#3535) Signed-off-by: Knative Automation <automation@knative.team> * Update common github actions (knative#3552) Signed-off-by: Knative Automation <automation@knative.team> * upgrade to latest dependencies (knative#3505) bumping knative.dev/hack 88c69cd...93ad912: > 93ad912 Print java and mvn version (# 65) > 86f9adc Fix default codegen pkg dir (# 67) Signed-off-by: Knative Automation <automation@knative.team> * Remove responsive-revision-gc config (knative#3545) Since knative/serving#10084 deleted old GC and started using responsive GC by default, `responsive-revision-gc` in `config-feature` is not used at all. This patch removes the configuration `responsive-revision-gc` in `config-feature` configmap. * Fixes knative#3117 and broken links (knative#3569) * Fix knative#3117 and broken links * Fix knative#3117 and broken links * remove spec folder and redirect page and update links * remove conflicts * Update shortcodes.md (knative#3550) minor grammar. * 💄 slight change to ordered delivery guarantees (knative#3536) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Add knative-release-leads to OWNERS (knative#3586) * add approvers ux (knative#3587) * Update the default value (knative#3530) * Adding notes on KafkaSource usage (knative#3596) * Adding some Kafka note for use-cases Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * changing the description Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * Update actions (knative#3581) Signed-off-by: Knative Automation <automation@knative.team> * Remove python pycache (knative#3594) * Use correct setting in ClusterIssue setting (knative#3595) The doc uses ClusterIssuer `letsencrypt-http01-issuer` but the configuration uses `letsencrypt-issuer` so it is confusable. Actual report is knative#3560. So this patch changes the ClusterIssuer name to `letsencrypt-http01-issuer` which is used in this doc section. Fix knative#3560 * fix broken link knative#3568 knative#3577 (knative#3579) * fix Netlify build * Added Snippets folder and hidden Beta Contributor guide * Update docs/eventing/event-registry.md Co-authored-by: Carlos Santana <csantana23@gmail.com> * whitespace * more whitespace * removing this bit because linting is killing me * ok really the last one * Updating to latest API version of Strimzi. v1beta1 is now gone 🔥 (knative#3603) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * 📓 adding a note to not consume records of the kafkachannel's topic... (knative#3615) Signed-off-by: Matthias Wessendorf <mwessend@redhat.com> * fix broken link in kogito example (knative#3602) * docs about usage of internal services in an "api-gateway" access model (knative#3597) Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> * api specs for v0.23 (knative#3619) Signed-off-by: Carlos Santana <csantana23@gmail.com> * Update serving/_index.md with network layer option (knative#3585) * Update _index.md [knative#3117] Add ref for contour * Update docs/serving/_index.md Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Omer B <obensaadon@vmware.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> * Fix typos in the sample yaml file (knative#3616) * EventType is not yet part of the v1 eventing API (knative#3576) * Remaining changes from now closed PRs Co-authored-by: Carlos Santana <csantana23@gmail.com> Co-authored-by: RichardJJG <rijohnson@vmware.com> Co-authored-by: knative-automation <automation@knative.team> Co-authored-by: Shashankft9 <48708039+Shashankft9@users.noreply.github.com> Co-authored-by: Ashleigh Brennan <abrennan@redhat.com> Co-authored-by: Benjamin Tan Wei Hao <benjamintanweihao@gmail.com> Co-authored-by: Kenjiro Nakayama <nakayamakenjiro@gmail.com> Co-authored-by: Jonathan Johnson <jonathan.johnson@dijure.com> Co-authored-by: Matthias Wessendorf <mwessend@redhat.com> Co-authored-by: Evan Anderson <evana@vmware.com> Co-authored-by: RichieEscarez <rescarez@google.com> Co-authored-by: NovaHe <heqianfly@gmail.com> Co-authored-by: Kevin Marquardsen <mr.kmarq@gmail.com> Co-authored-by: Lena Brüder <oss@lena-brueder.de> Co-authored-by: Brüder, Lena <lena.brueder@maxxeed.com> Co-authored-by: Sameer Vohra <vsameer@vmware.com> Co-authored-by: Mahdi K. Fard <xclud@users.noreply.github.com>
Fixes #3562
Proposed Changes
I promised to write down how to support
"httpProtocol": "Redirected"for the documentation found at https://knative.dev/docs/serving/samples/knative-routing-go/index.htmlThanks to @nak3 I found out how to do it, and wanted to make others lives easier by documenting it.
In case you think it would be better, I can also add graphics - but I did not have the sources of the already-present image, and did not want to make a bad copy of it.