Skip to content

Commit

Permalink
Rename and reword auto-tls feature to external-domain-tls (#5692)
Browse files Browse the repository at this point in the history
* Rename and reword `auto-tls` feature to `external-domain-tls`

* Fix redirects

* Fix broken links
  • Loading branch information
ReToCode authored Oct 5, 2023
1 parent 1b7a1b0 commit 6d93813
Show file tree
Hide file tree
Showing 11 changed files with 154 additions and 151 deletions.
8 changes: 4 additions & 4 deletions config/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ nav:
- Configuring ingress class: serving/services/ingress-class.md
- Configuring certificate class: serving/services/certificate-class.md
- Configuring custom domains: serving/services/custom-domains.md
- Using a custom TLS certificate for DomainMapping: serving/services/byo-certificate.md
- Using a custom TLS certificate for DomainMapping: serving/services/custom-tls-certificate-domain-mapping.md
- Using extensions enabled by QPOptions: serving/services/using-queue-extensions.md
# TODO: Add security section to docs?
- Configure resource requests and limits: serving/services/configure-requests-limits-services.md
Expand All @@ -147,18 +147,18 @@ nav:
- Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md
- Exclude namespaces from the Knative webhook: serving/webhook-customizations.md
- Configuring high-availability components: serving/config-ha.md
- Configuring HTTPS connections: serving/using-a-tls-cert.md
- Enabling auto-TLS certs: serving/using-auto-tls.md
- Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md
- Configuring domain names: serving/using-a-custom-domain.md
- Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md
- Extending Queue Proxy image with QPOptions: serving/queue-extensions.md
# Serving config
- Serving configuration:
- Configure Deployment resources: serving/configuration/deployment.md
- Configuring gradual rollout of traffic to Revisions: serving/configuration/rolling-out-latest-revision-configmap.md
- Feature and extension flags: serving/configuration/feature-flags.md
- Configure the Defaults ConfigMap: serving/configuration/config-defaults.md
- Serving encryption configuration:
- Using custom TLS certificates in the networking layer: serving/encryption/using-certificates-in-networking-layer.md
- Enabling automatic TLS certificate provisioning: serving/encryption/enabling-automatic-tls-certificate-provisioning.md
# Serving - Application Security
- Application security:
- About Security-Guard: serving/app-security/security-guard-about.md
Expand Down
7 changes: 3 additions & 4 deletions config/redirects.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
plugins:
redirects:
redirect_maps:
contributing/about.md: contributing/README.md
contributing/about.md: community/README.md
eventing/broker/kafka-broker/kafka-configmap.md: eventing/configuration/kafka-channel-configuration.md
eventing/broker/create-mtbroker.md: eventing/brokers/create-broker.md
eventing/broker/example-mtbroker.md: eventing/brokers/broker-developer-config-options.md
Expand All @@ -17,7 +17,6 @@ plugins:
reference/api/serving-api.md: serving/reference/serving-api.md
community/about.md: community/governance.md
contributing/contributing.md: community/contributing.md
contributing/about.md: community/governance.md
contributing/README.md: community/README.md
eventing/getting-started.md: getting-started/getting-started-eventing.md
admin/collecting-logs/README.md: serving/observability/logging/collecting-logs.md
Expand Down Expand Up @@ -105,7 +104,7 @@ plugins:
developer/serving/deploying-from-private-registry.md: serving/deploying-from-private-registry.md
developer/serving/rolling-out-latest-revision.md: serving/rolling-out-latest-revision.md
developer/serving/services/README.md: serving/services/README.md
developer/serving/services/byo-certificate.md: serving/services/byo-certificate.md
developer/serving/services/byo-certificate.md: serving/services/custom-tls-certificate-domain-mapping.md
developer/serving/services/certificate-class.md: serving/services/certificate-class.md
developer/serving/services/configure-requests-limits-services.md: serving/services/configure-requests-limits-services.md
developer/serving/services/creating-services.md: serving/services/creating-services.md
Expand Down Expand Up @@ -209,7 +208,7 @@ plugins:
serving/services/deployment.md: serving/configuration/deployment.md
serving/services/http-option.md: serving/services/http-protocol.md
serving/spec/knative-api-specification-1.0.md: https://github.com/knative/specs/blob/main/specs/serving/knative-api-specification-1.0.md
serving/using-an-ssl-cert/index.md: serving/using-a-tls-cert.md
serving/using-an-ssl-cert/index.md: serving/encryption/using-certificates-in-networking-layer.md
serving/using-subroutes.md: serving/traffic-management.md
about/case-studies/README.md: about/case-studies/deepc.md
eventing/brokers/create-mtbroker.md: eventing/brokers/create-broker.md
Expand Down
11 changes: 5 additions & 6 deletions docs/install/installing-cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
Install the [Cert-Manager](https://github.com/jetstack/cert-manager) tool to
obtain TLS certificates that you can use for secure HTTPS connections in
Knative. For more information about enabling HTTPS connections in Knative, see
[Configuring HTTPS with TLS certificates](../serving/using-a-tls-cert.md).
[Using custom certificates in networking-layer](../serving/encryption/using-certificates-in-networking-layer.md).

You can use cert-manager to either manually obtain certificates, or to enable
Knative for automatic certificate provisioning. Complete instructions about
automatic certificate provisioning are provided in
[Enabling automatic TLS cert provisioning](../serving/using-auto-tls.md).
Knative for automatic certificate provisioning. Complete instructions about this are provided in
[Enabling automatic TLS certificate provisioning](../serving/encryption/enabling-automatic-tls-certificate-provisioning.md).

Regardless of if your want to manually obtain certificates, or configure Knative
for automatic provisioning, you can use the following steps to install
Expand Down Expand Up @@ -36,8 +35,8 @@ configuring Knative:
- **Manual**: If you installed cert-manager to manually obtain certificates,
continue to the following topic for instructions about creating a Kubernetes
secret:
[Manually adding a TLS certificate](../serving/using-a-tls-cert.md#manually-adding-a-tls-certificate)
[Manually adding a TLS certificate](../serving/encryption/using-certificates-in-networking-layer.md#manually-adding-a-tls-certificate)

- **Automatic**: If you installed cert-manager to use for automatic certificate
provisioning, continue to the following topic to enable that feature:
[Enabling automatic TLS certificate provisioning in Knative](../serving/using-auto-tls.md)
[Enabling automatic TLS certificate provisioning](../serving/encryption/enabling-automatic-tls-certificate-provisioning.md)
21 changes: 5 additions & 16 deletions docs/install/yaml-install/serving/install-serving-with-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,20 +170,9 @@ The following tabs expand to show instructions for installing each Serving exten
=== "TLS with cert-manager"

Knative supports automatically provisioning TLS certificates through
[cert-manager](https://cert-manager.io/docs/). The following commands
install the components needed to support the provisioning of TLS certificates
through cert-manager.

1. Install [cert-manager version v1.0.0 or later](../../installing-cert-manager.md).

1. Install the component that integrates Knative with `cert-manager` by running the command:

```bash
kubectl apply -f {{ artifact(repo="net-certmanager",file="release.yaml")}}
```

1. Configure Knative to automatically configure TLS certificates by following the steps in
[Enabling automatic TLS certificate provisioning](../../../serving/using-auto-tls.md).
[cert-manager](https://cert-manager.io/docs/).
Follow the documentation in [Enabling automatic TLS certificate provisioning](../../../serving/encryption/enabling-automatic-tls-certificate-provisioning.md)
for more information.

=== "TLS with HTTP01"

Expand All @@ -204,11 +193,11 @@ The following tabs expand to show instructions for installing each Serving exten
--patch '{"data":{"certificate-class":"net-http01.certificate.networking.knative.dev"}}'
```

3. Enable autoTLS by running the command:
3. Enable `external-domain-tls` by running the command:

```bash
kubectl patch configmap/config-network \
--namespace knative-serving \
--type merge \
--patch '{"data":{"auto-tls":"Enabled"}}'
--patch '{"data":{"external-domain-tls":"Enabled"}}'
```
2 changes: 1 addition & 1 deletion docs/serving/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Examples of supported Knative Serving use cases:
- Autoscaling, including scaling pods down to zero.
- Support for multiple networking layers, such as Contour, Kourier, and Istio, for integration into existing environments.

Knative Serving supports both HTTP and [HTTPS](using-a-tls-cert.md) networking protocols.
Knative Serving supports both HTTP and [HTTPS](encryption/using-certificates-in-networking-layer.md) networking protocols.

## Installation

Expand Down
Loading

0 comments on commit 6d93813

Please sign in to comment.