Document ClusterDomainClaims (#3876)

* Document ClusterDomainClaims

* drop parenthetical
This commit is contained in:
Julian Friedman 2021-07-09 14:37:20 +01:00 committed by GitHub
parent f331139a06
commit 960c7cb7c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 3 deletions

View File

@ -22,8 +22,32 @@ serve a Knative Service at this domain.
## Procedure
1. Create a `DomainMapping` object by entering the following command:
1. By default, in order to create a DomainMapping you, or a cluster
administrator, must first delegate the domain name to the namespace you wish
to create the DomainMapping in by creating a ClusterDomainClaim.
ClusterDomainClaims delegate a domain name to a namespace, so that
DomainMappings in that namespace can use the domain name.
Create a ClusterDomainClaim by entering the following command:
```yaml
kubectl apply -f - <<EOF
apiVersion: networking.internal.knative.dev/v1alpha1
kind: ClusterDomainClaim
metadata:
name: <domain-name>
spec:
namespace: <namespace>
EOF
```
!!! tip
You can avoid this step by setting the `autocreateClusterDomainClaims`
property to "true" in the `config-network` config map, in the
`knative-serving` namespace. This allows any user, in any namespace, to
map any domain name, even ones in other namespaces or for domain names
that they do not own.
1. Create a DomainMapping object by entering the following command:
```yaml
kubectl apply -f - <<EOF
apiVersion: serving.knative.dev/v1alpha1
@ -44,8 +68,7 @@ serve a Knative Service at this domain.
- `<namespace>` is the namespace that contains both the `DomainMapping` and `Service` objects.
- `<service-name>` is the name of the service that will be mapped to the domain.
!!! note
!!! tip
You can also map to other targets as long as they conform to the Addressable contract and their resolved URL is of the form `{name}.{namespace}.{clusterdomain}`, where `{name}` and `{namespace}` are the name and namespace of a Kubernetes service, and `{clusterdomain}`is the cluster domain. Examples of objects that conform to this contract include Knative Services, Routes, and Kubernetes services.
1. Point the domain name to the IP address of your Knative cluster. Details of this step differ depending on your domain registrar.