-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Plugin: Kourier #6456
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
base: main
Are you sure you want to change the base?
Plugin: Kourier #6456
Conversation
Initial write up
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: iRaindrop The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Finished bringing over content
Misc edits
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious - we cover this stuff here already given it's related to serving - are these pages meant to be duplicated or are we cleaning out the sections?
| 1. Install Knative Serving if not already installed: | ||
|
|
||
| ``` bash | ||
| kubectl apply -f https://github.com/knative/serving/releases/latest/download/serving-crds.yaml | ||
| kubectl apply -f https://github.com/knative/serving/releases/latest/download/serving-core.yaml | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to Serving installation page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Dave - yes we should link to installing a network layer for both kourier and Contour. Will consult with Evan.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'd link this to ./yaml-install/serving/install-serving-with-yaml.md, rather than including inline instructions.
Also, we say that having Knative Serving installed is a pre-requisite, so it's weird to also have install instructions here.
I don't recall what the equivalent Operator version is, so you might want to leave a <!-- TODO: add operator-equivalent instructions --> somewhere in this file.
| 1. Install Kourier: | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://github.com/knative/net-kourier/releases/latest/download/kourier.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
latest should be a release version - we have a macro somewhere for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| kubectl apply -f https://github.com/knative/net-kourier/releases/latest/download/kourier.yaml | |
| kubectl apply -f {{ artifact(repo="net-kourier",org="knative-extensions",file="kourier.yaml" }} |
(Taken from the install-serving-with-yaml.md instructions.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for collecting this documentation! A few comments, but it's nice to have the documentation gathered in one place.
It looks like most of the configuration information was surfaced from outside the existing docs tree, so thanks for digging that up!
| 1. Install Knative Serving if not already installed: | ||
|
|
||
| ``` bash | ||
| kubectl apply -f https://github.com/knative/serving/releases/latest/download/serving-crds.yaml | ||
| kubectl apply -f https://github.com/knative/serving/releases/latest/download/serving-core.yaml | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'd link this to ./yaml-install/serving/install-serving-with-yaml.md, rather than including inline instructions.
Also, we say that having Knative Serving installed is a pre-requisite, so it's weird to also have install instructions here.
I don't recall what the equivalent Operator version is, so you might want to leave a <!-- TODO: add operator-equivalent instructions --> somewhere in this file.
| 1. Install Kourier: | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://github.com/knative/net-kourier/releases/latest/download/kourier.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| kubectl apply -f https://github.com/knative/net-kourier/releases/latest/download/kourier.yaml | |
| kubectl apply -f {{ artifact(repo="net-kourier",org="knative-extensions",file="kourier.yaml" }} |
(Taken from the install-serving-with-yaml.md instructions.)
| 1. Optional - Set your desired domain (replace `127.0.0.1.nip.io` to your preferred domain): | ||
|
|
||
| ```bash | ||
| kubectl patch configmap/config-domain \ | ||
| -n knative-serving \ | ||
| --type merge \ | ||
| -p '{"data":{"127.0.0.1.nip.io":""}}' | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not Kourier-specific, though we should describe how to find Kourier's external IP address (from install-serving-with-yaml.md):
kubectl --namespace kourier-system get service kourierI would put this in a separate section (since we have its own page). Something like "DNS configuration"
| ```bash | ||
| cat <<-EOF | kubectl apply -f - | ||
| apiVersion: serving.knative.dev/v1 | ||
| kind: Service | ||
| metadata: | ||
| name: helloworld-go | ||
| spec: | ||
| template: | ||
| spec: | ||
| containers: | ||
| - image: gcr.io/knative-samples/helloworld-go | ||
| env: | ||
| - name: TARGET | ||
| value: Go Sample v1 | ||
| EOF | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, I would either omit this, or put it in a "verification" section, since it's not required for the installation.
| 1. Optional - For testing purposes, you can use port-forwarding to make requests to Kourier from your machine: | ||
|
|
||
| ```bash | ||
| kubectl port-forward --namespace kourier-system $(kubectl get pod -n kourier-system -l "app=3scale-kourier-gateway" --output=jsonpath="{.items[0].metadata.name}") 8080:8080 19000:9000 8443:8443 | ||
|
|
||
| curl -v -H "Host: helloworld-go.default.127.0.0.1.nip.io" http://localhost:8080 | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I probably wouldn't include this at all. If we do want to include these commands, I'd put them under verification / troubleshooting, with the detail that these commands can help take external DNS resolution and cluster loadbalancing out of the picture if you think you're having trouble with those components. But I'd expect most administrators to be able to check those components themselves, since we're assuming that they have cluster administration experience, and a cluster with malfunctioning load balancing or DNS is probably going to have problems beyond Knative Serving.
|
|
||
| By default, the deployment of the Kourier components is split between two different namespaces: | ||
|
|
||
| - `knative-serving` - Namespace where Kourier control is deployed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - `knative-serving` - Namespace where Kourier control is deployed. | |
| - `knative-serving` - Namespace where Kourier controlle is deployed. |
| - External Authorization support. | ||
| - Proxy Protocol (AN EXPERIMENTAL / ALPHA FEATURE) | ||
|
|
||
| ## Setup TLS certificate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would put this and the remaining topics under a "Configuration" header, and move e.g. h2 elements to h3, and h3 to h4.
|
/assign |
|
/assign @dsimansk As the resident Kourier expert |
|
This content will now be under Configuring Knative->Networking Options->Plugin: Kourier |
Need topic to install the Kourier plugin. Source: https://github.com/knative-extensions/net-kourier
Proposed Changes