-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs Ingress default tls secret extra moonray comment (#656)
- Loading branch information
1 parent
74d645a
commit fc42a20
Showing
6 changed files
with
145 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,7 @@ Overview <self> | |
:glob: | ||
:titlesonly: | ||
install | ||
networking/index | ||
``` | ||
|
||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
# How to use default Ingress | ||
|
||
{{product}} allows you to configure Ingress into your cluster. When | ||
enabled, it tells your cluster how external HTTP and HTTPS traffic should be | ||
routed to its services. | ||
|
||
## What you'll need | ||
|
||
This guide assumes the following: | ||
|
||
- You have root or sudo access to the machine | ||
- You have a bootstrapped {{product}} cluster (see the [Getting | ||
Started][getting-started-guide] guide). | ||
|
||
## Check Ingress status | ||
|
||
Find out whether Ingress is enabled or disabled with the following command: | ||
|
||
``` | ||
sudo k8s status | ||
``` | ||
|
||
Please ensure that Ingress is enabled on your cluster. | ||
|
||
## Enable Ingress | ||
|
||
To enable Ingress, run: | ||
|
||
``` | ||
sudo k8s enable ingress | ||
``` | ||
|
||
For more information on the command, execute: | ||
|
||
``` | ||
sudo k8s help enable | ||
``` | ||
|
||
## Configure Ingress | ||
|
||
Discover your configuration options by running: | ||
|
||
``` | ||
sudo k8s get ingress | ||
``` | ||
|
||
You should see three options: | ||
|
||
|
||
- `default-tls-secret`: Name of the TLS (Transport Layer Security) Secret that | ||
will be used as the default Ingress certificate. The | ||
`TLSCertificateDelegation` is created in the `projectcontour-root` namespace. | ||
When defining an Ingress object, specify this secret as the default | ||
certificate by setting the `secretName` field under `spec.tls`. | ||
For further information, see the | ||
[TLS Certificate Delegation guide][tls-delegation] guide. | ||
- `enable-proxy-protocol`: If set, proxy protocol will be enabled for the | ||
Ingress. | ||
|
||
### TLS Secret | ||
|
||
You can create a TLS secret by following the official | ||
[Kubernetes documentation][kubectl-create-secret-tls/]. | ||
Please remember to use `sudo k8s kubectl` (See the [kubectl-guide]). | ||
|
||
Tell Ingress to use your new Ingress certificate: | ||
|
||
``` | ||
sudo k8s set ingress.default-tls-secret=<new-default-tls-secret> | ||
``` | ||
|
||
Replace `<new-default-tls-secret>` with the desired value for your Ingress | ||
configuration. | ||
|
||
### Proxy Protocol | ||
|
||
Enabling the proxy protocol allows passing client connection information to the | ||
backend service. | ||
|
||
Consult the official | ||
[Kubernetes documentation on the proxy protocol][proxy-protocol]. | ||
|
||
Use the following command to enable the proxy protocol: | ||
|
||
``` | ||
sudo k8s set ingress.enable-proxy-protocol=<new-enable-proxy-protocol> | ||
``` | ||
|
||
Adjust the value of `<new-enable-proxy-protocol>` with your proxy protocol | ||
requirements. | ||
|
||
## Disable Ingress | ||
|
||
You can `disable` the built-in ingress: | ||
|
||
``` {warning} Disabling Ingress may impact external access to services within | ||
your cluster. | ||
Ensure that you have alternative configurations in place before disabling Ingress. | ||
``` | ||
|
||
``` | ||
sudo k8s disable ingress | ||
``` | ||
|
||
For more information on this command, run: | ||
|
||
``` | ||
sudo k8s help disable | ||
``` | ||
|
||
<!-- LINKS --> | ||
|
||
[kubectl-create-secret-tls/]: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_create/kubectl_create_secret_tls/ | ||
[proxy-protocol]: https://kubernetes.io/docs/reference/networking/service-protocols/#protocol-proxy-special | ||
[getting-started-guide]: /snap/tutorial/getting-started | ||
[kubectl-guide]: /snap/tutorial/kubectl | ||
[tls-delegation]: https://projectcontour.io/docs/main/config/tls-delegation/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Networking | ||
|
||
```{toctree} | ||
:hidden: | ||
Networking <self> | ||
``` | ||
|
||
Networking is a core part of a working Kubernetes cluster. These topics cover | ||
how to configure and use key capabilities of {{product}}. | ||
|
||
```{toctree} | ||
:titlesonly: | ||
default-ingress-mr.md | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters