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

fixes #3462: update doc for setting up custom domain per service (#3497) 

* update doc for setting up custom domain per service

* set alias for removed custom-domain-per-servuice-doc

* Update docs/serving/creating-domain-mappings.md

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>
This commit is contained in:
Peter Mbanugo 2021-04-29 00:13:54 +02:00 committed by GitHub
parent 59310e1f67
commit b39d59a289
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/serving/creating-domain-mappings.md
View File

@ -1,8 +1,11 @@
---
title: "Creating a Mapping between a Custom Domain Name and a Knative Service (Alpha)"
linkTitle: "Creating Domain Mappings (Alpha)"
title: "Setting up a custom domain per Service"
linkTitle: "Setting up a custom domain per Service"
weight: 64
type: "docs"
aliases:
- /docs/serving/using-a-custom-domain-per-service
- /docs/serving/services/using-a-custom-domain-per-service
---
Knative services are automatically given a default domain name based on the
@ -42,30 +45,31 @@ multiple Domain Mappings to map multiple domains and subdomains.
1. Create a new file named `domainmapping.yaml` containing the following information.
```yaml
apiVersion: serving.knative.dev/v1alpha1
kind: DomainMapping
metadata:
```yaml
apiVersion: serving.knative.dev/v1alpha1
kind: DomainMapping
metadata:
name: example.org
namespace: default
spec:
spec:
ref:
name: helloworld-go
kind: Service
apiVersion: serving.knative.dev/v1
```
* `name`(metadata): The domain name you wish to map to the Knative service.
* `namespace`: The namespace that both domain mapping and the Knative service use.
* `name`(ref): The Knative service which should be used to service requests
for the custom domain name. 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. Objects conforming to this contract include Knative services and Routes, and Kubernetes services.
```
- `name`(metadata): The domain name you wish to map to the Knative service.
- `namespace`: The namespace that both domain mapping and the Knative service use.
- `name`(ref): The Knative service which should be used to service requests
for the custom domain name. 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. Objects conforming to this contract include Knative services and Routes, and Kubernetes services.
1. From the directory where the new `domainmapping.yaml` file was created,
deploy the domain mapping by applying the `domainmapping.yaml` file.
```
kubectl apply -f domainmapping.yaml
```
```
kubectl apply -f domainmapping.yaml
```
1. You will also need to point the `example.org` domain name at the IP
address of your Knative cluster. Details of this step differ depending on

61
docs/serving/services/using-a-custom-domain-per-service.md
View File

@ -1,61 +0,0 @@
---
title: "Setting up a custom domain per Service"
weight: 04
type: "docs"
aliases:
- /docs/serving/using-a-custom-domain-per-service
---
By default, Knative uses the `{route}.{namespace}.{default-domain}` fully qualified domain name for services, where `default-domain` is `example.com`.
You can change the `default-domain` by [Setting up a custom domain](../using-a-custom-domain). You can also set a custom domain per service, by using a custom FQDN for a service, or by using [custom domain mapping](../creating-domain-mappings/).
## Procedure
1. Edit the `domainTemplate` entry on the `config-network` configuration:
```shell
kubectl edit cm config-network --namespace knative-serving
```
Replace the `domainTemplate` with the following (the spaces must be respected):
```yaml
[...]
data:
[...]
domainTemplate: |-
{{if index .Annotations "custom-hostname" -}}
{{- index .Annotations "custom-hostname" -}}
{{else -}}
{{- .Name}}.{{.Namespace -}}
{{end -}}
.{{.Domain}}
```
Save and close your editor.
1. In a service definition, add the `custom-hostname` annotation:
```yaml
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
name: hello-world
annotations:
# the Service FQDN will become hello-world.{default-domain}
custom-hostname: hello-world
spec:
[...]
```
Apply your changes.
1. Verify that the service was created with the specified hostname:
```shell
kubectl get ksvc hello-world
NAME URL LATESTCREATED LATESTREADY READY REASON
hello-world http://hello-world.example.com hello-world-nfqh2 hello-world-nfqh2 True
```