Add DomainMapping docs #3017

julz · 2020-11-09T11:47:27Z

Documents the DomainMapping feature which will be added in alpha in v0.19.

This probably needs lots of work @abrennan89 @mpetason, but opening as a first version, anyway.

In particular looking for guidance on how best to call out that this is an Alpha feature etc.

csantanapr · 2020-11-09T13:39:58Z

Documents the DomainMapping feature which will be added in alpha in v0.18.

You meant to say v0.19 ?

csantanapr · 2020-11-09T13:40:30Z

docs/serving/creating-domain-mappings.md

+
+If the Domain Mapping feature is installed, you can serve
+custom domains backed by Knative Services. For example, if you
+own the "MyDomain.com" domain name, you can point DNS at your


Maybe using lower case is better “mydomain.com”

d'oh, thanks, fixed

julz · 2020-11-09T13:41:45Z

You meant to say v0.19 ?

I did. And as one of the release managers for 0.19: oops 😂 .

csantanapr · 2020-11-09T13:43:07Z

docs/serving/creating-domain-mappings.md

+type: "docs"
+---
+
+If the Domain Mapping feature is installed, you can serve


This sentence sounds like the user needs to install an optional components when installing knative..
Is this true or you mean that user use a knative 0.19+ that contains this CRD and that the state of the feature is alpha and we want feedback early

Yes, the user does need to install an additional component -- it's not installed by default in this release (there's an extra yaml file, much like installing the monitoring bundle or HPA autoscaler). I'll PR an update to install docs separately with that optional step.

Add a reference and link here you don’t have to put the actual steps here

I will when I've added that step to the docs :)

I think we need to add to this doc the limitations, that not all net ingress support this feature, you can list them here, or mention in the install doc and point there from here.

csantanapr · 2020-11-09T13:44:15Z

docs/serving/creating-domain-mappings.md

+  apiVersion: serving.knative.dev/v1alpha1
+  kind: DomainMapping
+  metadata:
+   name: mydomain.com


Is there a spec.domain field? Because I would be very disappointed if the actual domain value is the name of the CR

It's intentionally the name of the DM to prevent collisions. Here's one of the conversations in the design doc where we decided this: https://docs.google.com/document/d/1yXSuKpQqZM5tczBFpPG8TGQoWSkvmoA17nPwDd1UxEI/edit?disco=AAAAG2yt488.

csantanapr · 2020-11-09T13:46:16Z

docs/serving/creating-domain-mappings.md

+To create a mapping from a custom domain to a Knative Service, you need to
+create a YAML file that defines a Domain Mapping.
+This YAML file specifies the domain name to map and the Knative Service to use
+to service requests.


Put some reference to the example “mydomain.com” explain if using this value would cover all sub domains ? *.mydomain.com or it needs to a specific domain ?

added an extra para here, ptal

csantanapr · 2020-11-09T13:47:45Z

docs/serving/creating-domain-mappings.md

+  metadata:
+   name: mydomain.com
+   namespace: default
+  spec:


spec.domain missing?

no, see above

csantanapr · 2020-11-09T13:53:23Z

docs/serving/creating-domain-mappings.md

+linkTitle: "Creating Domain Mappings (Alpha)"
+weight: 64
+type: "docs"
+---


The intro needs some use case if not would very confusing for the end user on why she would need this feature.

You can put something like
knative by default offeres a comfigmap “config-domain” in the control plane namespace (Ie knative-serving”) that allow an admin with write access to the namespace edit the comfigmap to configure domain names including a selector to be use which services corresponds to a domain name..
But in some cases the admin would not want this ConfigMap to be edited and would prefer users to define the domain name mapping to be fine by users in the namespace where the knative service is deploy.
This feature would allow to define the mapping in their namespace by creating a Kubernetes resource DomainMapping

How about just "Knative Services are automatically given a default domain name based on the cluster configuration. You can also map a single custom domain name that you own to a specific Knative Service using the Domain Mapping feature."?

julz · 2020-11-09T13:56:19Z

/hold so I can link to the install instructions in the first sentence (once I PR that step to them :)).

abrennan89 · 2020-12-16T19:11:25Z

@julz is this one ready for docs review / merge?

abrennan89 · 2020-12-16T19:13:00Z

Question: is this related to #1964? Might it close that issue?

julz · 2021-01-04T10:05:42Z

/unhold should be ready for review now @abrennan89

julz · 2021-01-04T10:08:35Z

Question: is this related to #1964? Might it close that issue?

I think it might @abrennan89. This documents the feature that - iiuc - @ahmetb was expecting the other doc to be about. Hopefully @ahmetb can confirm if so

ahmetb · 2021-01-04T16:01:45Z

Correct. That issue asks for this PR.

duglin · 2021-01-13T20:34:24Z

docs/serving/creating-domain-mappings.md

+## Before you begin
+
+1. You need to enable the DomainMapping feature (and a supported Knative
+   Ingress implementation) to use it. See [the Install instructions](../install/).


where on that page should people look? I didn't see anything covering this topic. Perhaps we could point to the exact page of interest?

nak3

@julz It seems mydomain.com is already used by some organization in the real world so should we change the example domain like mydomain.example.org which is listed in RFC2606 - 3. Reserved Example Second Level Domain Names?

julz · 2021-01-18T16:05:54Z

oops - thanks @nak3, will update!

julz · 2021-01-21T10:58:25Z

Ready for another look @abrennan89 @nak3

csantanapr · 2021-01-21T11:12:05Z

/lgtm

nak3 · 2021-01-21T12:06:08Z

/lgtm

csantanapr · 2021-01-21T12:14:40Z

/approve

knative-prow-robot · 2021-01-21T12:14:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: csantanapr, julz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~docs/serving/OWNERS~~ [csantanapr]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

nak3 · 2021-01-21T15:28:40Z

/hold cancel

nak3 · 2021-01-22T03:25:08Z

/cherrypick release-0.20
/cherrypick release-0.19

knative-prow-robot · 2021-01-22T03:25:16Z

@nak3: new pull request created: #3183

In response to this:

/cherrypick release-0.20
/cherrypick release-0.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

nak3 · 2021-01-22T03:26:07Z

/cherrypick release-0.19

knative-prow-robot · 2021-01-22T03:26:14Z

@nak3: new pull request created: #3184

In response to this:

/cherrypick release-0.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

* Add DomainMapping docs * x * My oh my * Add paragraph about wildcard (lack of) behaviour * Update description and link to install docs * Update link, use example.org domain, and elaborate contract for Ref

Add DomainMapping docs

408c0b7

google-cla bot added the cla: yes Indicates the PR's author has signed the CLA. label Nov 9, 2020

knative-prow-robot requested review from markusthoemmes and vagababov November 9, 2020 11:47

knative-prow-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 9, 2020

x

961a106

csantanapr reviewed Nov 9, 2020

View reviewed changes

My oh my

6115124

csantanapr reviewed Nov 9, 2020

View reviewed changes

Add paragraph about wildcard (lack of) behaviour

1051385

csantanapr reviewed Nov 9, 2020

View reviewed changes

julz changed the title ~~Add DomainMapping docs~~ WIP: Add DomainMapping docs Nov 9, 2020

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 9, 2020

julz changed the title ~~WIP: Add DomainMapping docs~~ Add DomainMapping docs Nov 9, 2020

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 9, 2020

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 9, 2020

julz mentioned this pull request Nov 12, 2020

Add install instructions for DomainMapping CRD #3030

Merged

abrennan89 added cherrypick-0.19 kind/serving labels Dec 16, 2020

abrennan89 added this to the v0.20.0 milestone Dec 16, 2020

Update description and link to install docs

b233af7

abrennan89 linked an issue Jan 4, 2021 that may be closed by this pull request

Custom domains doc only explains customizing default domain #1964

Closed

duglin reviewed Jan 13, 2021

View reviewed changes

abrennan89 modified the milestones: v0.20.0, Backlog Jan 14, 2021

nak3 reviewed Jan 18, 2021

View reviewed changes

Update link, use example.org domain, and elaborate contract for Ref

b35f78c

knative-prow-robot assigned csantanapr Jan 21, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 21, 2021

knative-prow-robot assigned nak3 Jan 21, 2021

knative-prow-robot added the approved label Jan 21, 2021

knative-prow-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 21, 2021

knative-prow-robot merged commit f449dff into knative:master Jan 21, 2021

knative-prow-robot mentioned this pull request Jan 22, 2021

[release-0.20] Add DomainMapping docs #3183

Merged

knative-prow-robot mentioned this pull request Jan 22, 2021

[release-0.19] Add DomainMapping docs #3184

Merged

Add DomainMapping docs #3017

Add DomainMapping docs #3017

Uh oh!

Conversation

julz commented Nov 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

csantanapr commented Nov 9, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julz commented Nov 9, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julz Nov 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julz commented Nov 9, 2020

Uh oh!

abrennan89 commented Dec 16, 2020

Uh oh!

abrennan89 commented Dec 16, 2020

Uh oh!

julz commented Jan 4, 2021

Uh oh!

julz commented Jan 4, 2021

Uh oh!

ahmetb commented Jan 4, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nak3 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julz commented Jan 18, 2021

Uh oh!

julz commented Jan 21, 2021

Uh oh!

csantanapr commented Jan 21, 2021

Uh oh!

nak3 commented Jan 21, 2021

Uh oh!

csantanapr commented Jan 21, 2021

Uh oh!

knative-prow-robot commented Jan 21, 2021

Uh oh!

nak3 commented Jan 21, 2021

Uh oh!

nak3 commented Jan 22, 2021

Uh oh!

knative-prow-robot commented Jan 22, 2021

julz commented Nov 9, 2020 •

edited

Loading

julz Nov 9, 2020 •

edited

Loading

nak3 left a comment •

edited

Loading