diff --git a/.github/actions/mkdocs/Dockerfile b/.github/actions/mkdocs/Dockerfile index 388cc3c17..b5b564d3e 100644 --- a/.github/actions/mkdocs/Dockerfile +++ b/.github/actions/mkdocs/Dockerfile @@ -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 diff --git a/Makefile b/Makefile index 7ca9f0968..d176a6c08 100644 --- a/Makefile +++ b/Makefile @@ -164,10 +164,12 @@ dev-env-stop: ## Deletes local Kubernetes cluster created by kind. .PHONY: live-docs 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 \ -p 8000:8000 \ -v ${PWD}:/docs \ - squidfunk/mkdocs-material:5.5.12 + --entrypoint mkdocs \ + ingress-nginx-docs serve --dev-addr=0.0.0.0:8000 .PHONY: misspell misspell: ## Check for spelling errors. diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 16a9e07f5..4249827c4 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -31,6 +31,7 @@ - [Provider Specific Steps](#provider-specific-steps) - [Docker for Mac](#docker-for-mac) - [minikube](#minikube) + - [microk8s](#microk8s) - [AWS](#aws) - [GCE - GKE](#gce-gke) - [Azure](#azure) @@ -59,6 +60,16 @@ For standard usage: 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 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 kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.43.0/deploy/static/provider/baremetal/deploy.yaml ``` + !!! tip 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). ### Verify installation diff --git a/mkdocs.yml b/mkdocs.yml index 3bb562efc..fe2ad10c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,24 +3,52 @@ repo_name: "kubernetes/ingress-nginx" repo_url: https://github.com/kubernetes/ingress-nginx site_url: https://kubernetes.github.io/ingress-nginx +# Extensions markdown_extensions: - - attr_list - - pymdownx.emoji - admonition - - codehilite - - pymdownx.inlinehilite - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.superfences + - abbr + - attr_list + - def_list + - footnotes - meta + - md_in_html - toc: # insert a blank space before the character 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: name: material features: - - tabs - - instant + - navigation.tabs + - navigation.tabs.sticky + - navigation.instant + - navigation.sections palette: primary: "teal" @@ -31,6 +59,8 @@ theme: plugins: - search - awesome-pages + - minify: + minify_html: true extra_css: [extra.css]