Add user guide for ingress nginx. #1159
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/M
| @@ -0,0 +1,56 @@ | |||
| # Ingress Nginx | |||
There was a problem hiding this comment.
we need some front matter metadata at the top
There was a problem hiding this comment.
nit: Nginx -> NGINX, it's same case
| @@ -0,0 +1,56 @@ | |||
| # Ingress Nginx | |||
|
|
|||
| Ingress Nginx in kind works by exposing ports `80(http)` and `443(https)` | |||
There was a problem hiding this comment.
maybe s/works/can be setup/ -- "works" implies this is the only solution or that we bundle a solution.
|
|
||
| ## Create A Cluster with Ingress Nginx | ||
|
|
||
| The following shell script will create a kind cluster deploy |
| effect: NoSchedule | ||
| EOF | ||
| )" | ||
| ``` |
There was a problem hiding this comment.
can we add some basic usage?
we should at least link to the k8s.io ingress docs more
|
WDYT about titling the guide I'm sure the contour folks would love to pitch in, and we should probably dedupe the content. |
k8s-ci-robot
added
size/L
amwat
force-pushed
the
nginx
branch
2 times, most recently
from
daacdbb
to
4dc870d
Compare
site/content/docs/user/ingress.md
Outdated
| hostPort: 443 | ||
| nodeSelector: | ||
| # schedule it on the control-plane node | ||
| node-role.kubernetes.io/master: '' |
There was a problem hiding this comment.
maybe mention somewhere that this config only works if we have only one control-plane node, but is independent of the number of worker nodes?
There was a problem hiding this comment.
maybe we should do the label thing then /shrug
There was a problem hiding this comment.
yeah added labels instead
|
netlify is gone again :( |
site/content/docs/user/ingress.md
Outdated
| and an Ingress object to route to these services. | ||
|
|
||
| ```bash | ||
| cat <<EOF | kubectl apply -f - |
There was a problem hiding this comment.
this is somewhat unweildy for a cat EOF pipe thing, maybe we should split out the file contents and the apply (and perhaps host the actual contents as a file in static?)
site/content/docs/user/ingress.md
Outdated
| Apply the contents | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://raw.githubusercontent.com/kubernetes-sigs/kind/master/site/content/docs/user/ingress-nginx-example.yaml |
There was a problem hiding this comment.
if we put this in static/ we can get a URL on the site
maybe static/manifests or something
then https://kind.sigs.k8s.io/manifests/ingress-nginx-example.yaml
later we can template in the site URL
site/content/docs/user/ingress.md
Outdated
| kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/mandatory.yaml | ||
|
|
||
| # Apply kind specific patches | ||
| kubectl patch deployments -n ingress-nginx nginx-ingress-controller -p "$(cat<<EOF |
There was a problem hiding this comment.
can kubectl patch take in a URL for the patch?
|
/retest |
|
merging and iterating. still would like to see some changes |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: amwat, BenTheElder The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
| nodeRegistration: | ||
| kubeletExtraArgs: | ||
| node-labels: "ingress-ready=true" | ||
| authorization-mode: "AlwaysAllow" |
There was a problem hiding this comment.
Wait a sec, what's this about? 😅
There was a problem hiding this comment.
i don't think this is needed for nginx ingress and it's not a recommended practice.
There was a problem hiding this comment.
I can confirm this is not required or recommended in ingress-nginx. Maybe it is required for something else?
There was a problem hiding this comment.
i suspect this is not needed.
There was a problem hiding this comment.
Yeah, if it's working without it we can probably safely remove this.
Create a basic user guide that follows https://kubernetes.github.io/ingress-nginx/deploy/#prerequisite-generic-deployment-command and exposes hostPorts to make it work.