Update mkdocs, fix nodeport link and add microk8s link
This commit is contained in:
parent
d1082745c9
commit
5d1770ad1d
4 changed files with 59 additions and 12 deletions
4
.github/actions/mkdocs/Dockerfile
vendored
4
.github/actions/mkdocs/Dockerfile
vendored
|
@ -1,4 +1,6 @@
|
||||||
FROM squidfunk/mkdocs-material:5.5.12
|
FROM squidfunk/mkdocs-material:6.2.4
|
||||||
|
|
||||||
|
RUN pip install mkdocs-awesome-pages-plugin
|
||||||
|
|
||||||
COPY action.sh /action.sh
|
COPY action.sh /action.sh
|
||||||
|
|
||||||
|
|
4
Makefile
4
Makefile
|
@ -164,10 +164,12 @@ dev-env-stop: ## Deletes local Kubernetes cluster created by kind.
|
||||||
|
|
||||||
.PHONY: live-docs
|
.PHONY: live-docs
|
||||||
live-docs: ## Build and launch a local copy of the documentation website in http://localhost:8000
|
live-docs: ## Build and launch a local copy of the documentation website in http://localhost:8000
|
||||||
|
@docker build -t ingress-nginx-docs .github/actions/mkdocs
|
||||||
@docker run --rm -it \
|
@docker run --rm -it \
|
||||||
-p 8000:8000 \
|
-p 8000:8000 \
|
||||||
-v ${PWD}:/docs \
|
-v ${PWD}:/docs \
|
||||||
squidfunk/mkdocs-material:5.5.12
|
--entrypoint mkdocs \
|
||||||
|
ingress-nginx-docs serve --dev-addr=0.0.0.0:8000
|
||||||
|
|
||||||
.PHONY: misspell
|
.PHONY: misspell
|
||||||
misspell: ## Check for spelling errors.
|
misspell: ## Check for spelling errors.
|
||||||
|
|
|
@ -31,6 +31,7 @@
|
||||||
- [Provider Specific Steps](#provider-specific-steps)
|
- [Provider Specific Steps](#provider-specific-steps)
|
||||||
- [Docker for Mac](#docker-for-mac)
|
- [Docker for Mac](#docker-for-mac)
|
||||||
- [minikube](#minikube)
|
- [minikube](#minikube)
|
||||||
|
- [microk8s](#microk8s)
|
||||||
- [AWS](#aws)
|
- [AWS](#aws)
|
||||||
- [GCE - GKE](#gce-gke)
|
- [GCE - GKE](#gce-gke)
|
||||||
- [Azure](#azure)
|
- [Azure](#azure)
|
||||||
|
@ -59,6 +60,16 @@ For standard usage:
|
||||||
minikube addons enable ingress
|
minikube addons enable ingress
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### microk8s
|
||||||
|
|
||||||
|
For standard usage:
|
||||||
|
|
||||||
|
```console
|
||||||
|
microk8s enable ingress
|
||||||
|
```
|
||||||
|
|
||||||
|
Please check the microk8s [documentation page](https://microk8s.io/docs/addon-ingress)
|
||||||
|
|
||||||
#### AWS
|
#### AWS
|
||||||
|
|
||||||
In AWS we use a Network load balancer (NLB) to expose the NGINX Ingress controller behind a Service of `Type=LoadBalancer`.
|
In AWS we use a Network load balancer (NLB) to expose the NGINX Ingress controller behind a Service of `Type=LoadBalancer`.
|
||||||
|
@ -157,9 +168,11 @@ Using [NodePort](https://kubernetes.io/docs/concepts/services-networking/service
|
||||||
```console
|
```console
|
||||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.43.0/deploy/static/provider/baremetal/deploy.yaml
|
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.43.0/deploy/static/provider/baremetal/deploy.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
Applicable on kubernetes clusters deployed on bare-metal with generic Linux distro(Such as CentOs, Ubuntu ...).
|
Applicable on kubernetes clusters deployed on bare-metal with generic Linux distro(Such as CentOs, Ubuntu ...).
|
||||||
!!! tip
|
|
||||||
|
!!! info
|
||||||
For extended notes regarding deployments on bare-metal, see [Bare-metal considerations](./baremetal.md).
|
For extended notes regarding deployments on bare-metal, see [Bare-metal considerations](./baremetal.md).
|
||||||
|
|
||||||
### Verify installation
|
### Verify installation
|
||||||
|
|
48
mkdocs.yml
48
mkdocs.yml
|
@ -3,24 +3,52 @@ repo_name: "kubernetes/ingress-nginx"
|
||||||
repo_url: https://github.com/kubernetes/ingress-nginx
|
repo_url: https://github.com/kubernetes/ingress-nginx
|
||||||
site_url: https://kubernetes.github.io/ingress-nginx
|
site_url: https://kubernetes.github.io/ingress-nginx
|
||||||
|
|
||||||
|
# Extensions
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- attr_list
|
|
||||||
- pymdownx.emoji
|
|
||||||
- admonition
|
- admonition
|
||||||
- codehilite
|
- abbr
|
||||||
- pymdownx.inlinehilite
|
- attr_list
|
||||||
- pymdownx.tasklist:
|
- def_list
|
||||||
custom_checkbox: true
|
- footnotes
|
||||||
- pymdownx.superfences
|
|
||||||
- meta
|
- meta
|
||||||
|
- md_in_html
|
||||||
- toc:
|
- toc:
|
||||||
# insert a blank space before the character
|
# insert a blank space before the character
|
||||||
permalink: " ¶"
|
permalink: " ¶"
|
||||||
|
- pymdownx.arithmatex:
|
||||||
|
generic: true
|
||||||
|
- pymdownx.betterem:
|
||||||
|
smart_enable: all
|
||||||
|
- pymdownx.caret
|
||||||
|
- pymdownx.critic
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
- pymdownx.highlight
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- pymdownx.keys
|
||||||
|
- pymdownx.mark
|
||||||
|
- pymdownx.smartsymbols
|
||||||
|
- pymdownx.snippets:
|
||||||
|
check_paths: true
|
||||||
|
- pymdownx.superfences:
|
||||||
|
custom_fences:
|
||||||
|
- name: mermaid
|
||||||
|
class: mermaid
|
||||||
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||||
|
- pymdownx.tabbed
|
||||||
|
- pymdownx.tasklist:
|
||||||
|
custom_checkbox: true
|
||||||
|
- pymdownx.tilde
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
features:
|
features:
|
||||||
- tabs
|
- navigation.tabs
|
||||||
- instant
|
- navigation.tabs.sticky
|
||||||
|
- navigation.instant
|
||||||
|
- navigation.sections
|
||||||
|
|
||||||
palette:
|
palette:
|
||||||
primary: "teal"
|
primary: "teal"
|
||||||
|
@ -31,6 +59,8 @@ theme:
|
||||||
plugins:
|
plugins:
|
||||||
- search
|
- search
|
||||||
- awesome-pages
|
- awesome-pages
|
||||||
|
- minify:
|
||||||
|
minify_html: true
|
||||||
|
|
||||||
extra_css: [extra.css]
|
extra_css: [extra.css]
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue