knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add how to create custom domains with kn domain (#4209) 

* Add `kn domain` usage for creating a domain mapping.

While on it, also added how to enable TLS for the domain mapping.

* Update docs/developer/serving/services/custom-domains.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

Co-authored-by: Samia Nneji <snneji@vmware.com>
This commit is contained in:
Roland Huß 2021-09-10 19:12:31 +02:00 committed by GitHub
parent 375e925b5c
commit 861298bbbe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/developer/serving/services/custom-domains.md
View File

@ -54,6 +54,8 @@ DomainMappings in that namespace to use the domain name.
namespaces or for domain names that they do not own.
<!-- insert example snippet -->
=== "Apply YAML"
1. Create a DomainMapping object:
1. Create a YAML file using the following template:
@ -69,11 +71,14 @@ DomainMappings in that namespace to use the domain name.
name: <service-name>
kind: Service
apiVersion: serving.knative.dev/v1
tls:
secret: <cert-secret>
```
Where:
- `<domain-name>` is the domain name that you want to map a Service to.
- `<namespace>` is the namespace that contains both the `DomainMapping` and `Service` objects.
- `<service-name>` is the name of the Service that is mapped to the domain.
- `<cert-secret>` is the name of a Secret that holds the server certificate for TLS communication. If this optional `tls:` section is provided, the protocol is switched from HTTP to HTTPS.
!!! 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.
@ -86,5 +91,19 @@ DomainMappings in that namespace to use the domain name.
```
Where `<filename>` is the name of the file you created in the previous step.
=== "kn CLI"
```
kn domain create <domain-name> --ref <target> --tls <tls-secret> --namespace <namespace>
```
Where:
- `<domain-name>` is the domain name that you want to map a Service or Route to.
- `<target>` is the name of the Service or Route that is mapped to the domain. You can use a prefix `ksvc:` or `kroute:` to specify whether to map the domain to a Knative Service or Route. If no prefix is given, `ksvc:` is assumed. Additionally, you can use a `:namespace` suffix to point to a Service or Route in a different namespace than this Domain mapping. E.g. `mysvc` maps to a Service `mysvc` in the same namespace as this mapping, while `kroute:myroute:othernamespace` maps to a Route `myroute` in namespace `othernamespace`.
- `<tls-secret>` is optional and if provided enables the TLS protocol. The value specifies the secret that holds the server certificate.
- `<namespace>` is the namespace where the DomainMapping should be created. By default the DomainMapping is created in the current namespace.
In addition to creating DomainMappings, `kn domain` can be used to list, describe, update and delete existing DomainMappings. See `kn domain --help` for more information.
1. Point the domain name to the IP address of your Knative cluster. Details of this step differ
depending on your domain registrar.