Add domain and realm CRDs

config/300-domain.yaml

@@ -0,0 +1,39 @@
+# Copyright 2020 The Knative Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: domains.networking.internal.knative.dev
+  labels:
+    serving.knative.dev/release: devel
+    knative.dev/crd-install: "true"
+spec:
+  group: networking.internal.knative.dev
+  versions:
+  - name: v1alpha1
+    served: true
+    storage: true
+  names:
+    kind: Domain
+    plural: domains
+    singular: domain
+    categories:
+    - knative-internal
+    - networking
+    shortNames:
+    - dom
+  scope: Cluster
+  subresources:
+    status: {}

config/300-realm.yaml

@@ -0,0 +1,44 @@
+# Copyright 2020 The Knative Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: realms.networking.internal.knative.dev
+  labels:
+    serving.knative.dev/release: devel
+    knative.dev/crd-install: "true"
+spec:
+  group: networking.internal.knative.dev
+  versions:
+  - name: v1alpha1
+    served: true
+    storage: true
+  names:
+    kind: Realm
+    plural: realms
+    singular: realm
+    categories:
+    - knative-internal
+    - networking
+  scope: Cluster
+  subresources:
+    status: {}
+  additionalPrinterColumns:
+  - name: Ready
+    type: string
+    JSONPath: ".status.conditions[?(@.type=='Ready')].status"
+  - name: Reason
+    type: string
+    JSONPath: ".status.conditions[?(@.type=='Ready')].reason"

pkg/apis/networking/v1alpha1/domain_defaults.go

@@ -0,0 +1,32 @@
+/*
+Copyright 2020 The Knative Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	"context"
+
+	"knative.dev/pkg/apis"
+)
+
+// SetDefaults populates default values in Domain
+func (d *Domain) SetDefaults(ctx context.Context) {
+	d.Spec.SetDefaults(apis.WithinSpec(ctx))
+}
+
+// SetDefaults populates default values in DomainSpec
+func (s *DomainSpec) SetDefaults(ctx context.Context) {
+}

pkg/apis/networking/v1alpha1/domain_defaults_test.go

@@ -0,0 +1,33 @@
+/*
+Copyright 2020 The Knative Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	"context"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+func TestDomainDefaults(t *testing.T) {
+	d := Domain{}
+	d.SetDefaults(context.Background())
+
+	if !cmp.Equal(Domain{}, d) {
+		t.Errorf("SetDefaults (-want, +got) = \n%s", cmp.Diff(Domain{}, d))
+	}
+}

pkg/apis/networking/v1alpha1/domain_lifecycle.go

@@ -0,0 +1,34 @@
+/*
+Copyright 2020 The Knative Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"knative.dev/pkg/apis"
+)
+
+var domainCondSet = apis.NewLivingConditionSet()
+
+// GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.
+func (*Domain) GetConditionSet() apis.ConditionSet {
+	return domainCondSet
+}
+
+// GetGroupVersionKind returns SchemeGroupVersion of an Domain
+func (*Domain) GetGroupVersionKind() schema.GroupVersionKind {
+	return SchemeGroupVersion.WithKind("Domain")
+}

pkg/apis/networking/v1alpha1/domain_lifecycle_test.go

@@ -0,0 +1,39 @@
+/*
+Copyright 2020 The Knative Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package v1alpha1
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"knative.dev/pkg/apis"
+)
+
+func TestDomainGetConditionSet(t *testing.T) {
+	d := Domain{}
+
+	if got, want := d.GetConditionSet().GetTopLevelConditionType(), apis.ConditionReady; got != want {
+		t.Errorf("GetConditionSet=%v, want=%v", got, want)
+	}
+}
+
+func TestDomainGetGroupVersionKind(t *testing.T) {
+	d := Domain{}
+	expected := SchemeGroupVersion.WithKind("Domain")
+	if !cmp.Equal(expected, d.GetGroupVersionKind()) {
+		t.Errorf("Unexpected diff (-want, +got) = %v", cmp.Diff(expected, d.GetGroupVersionKind()))
+	}
+}

pkg/apis/networking/v1alpha1/domain_types.go

@@ -0,0 +1,160 @@
+/*
+Copyright 2020 The Knative Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"knative.dev/pkg/apis"
+	duckv1 "knative.dev/pkg/apis/duck/v1"
+	"knative.dev/pkg/kmeta"
+)
+
+// +genclient
+// +genclient:nonNamespaced
+// +genreconciler:krshapedlogic=true
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// Domain is a cluster-scoped resource to configure a proxy pool for a given Route.
+type Domain struct {
+	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// Spec is the desired state of the Domain.
+	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+	// +optional
+	Spec DomainSpec `json:"spec,omitempty"`
+
+	// Status is the current state of the Domain.
+	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+	// +optional
+	Status DomainStatus `json:"status,omitempty"`
+}
+
+// Verify that Domain adheres to the appropriate interfaces.
+var (
+	// Check that Doimain may be validated and defaulted.
+	_ apis.Validatable = (*Domain)(nil)
+	_ apis.Defaultable = (*Domain)(nil)
+
+	// Check that we can create OwnerReferences to a Domain.
+	_ kmeta.OwnerRefable = (*Domain)(nil)
+
+	// Check that the type conforms to the duck Knative Resource shape.
+	_ duckv1.KRShaped = (*Domain)(nil)
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// DomainList is a collection of Domain objects.
+type DomainList struct {
+	metav1.TypeMeta `json:",inline"`
+	// Standard object metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+	// +optional
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	// Items is the list of Domain objects.
+	Items []Domain `json:"items"`
+}
+
+// DomainSpec describes the Ingress the user wishes to exist.
+//
+// In general this follows the same shape as K8s Ingress.
+// Some notable differences:
+// - Backends now can have namespace:
+// - Traffic can be split across multiple backends.
+// - Timeout & Retry can be configured.
+// - Headers can be appended.
+// DomainSpec contains the specification of the Domain CRD.
+type DomainSpec struct {
+	// IngressClass tells what Ingress class annotation to use for Routes associated
+	// with this Realm.
+	IngressClass string `json:"ingressClass"`
+
+	// Suffix specifies the domain suffix to be used. This field replaces the
+	// existing config-domain ConfigMap.  Internal Domains can omit this, in
+	// which case we will default to the cluster suffix.
+	// +optional
+	Suffix string `json:"suffix,omitempty"`
+
+	// LoadBalancers provide addresses (IP addresses, domains) of the load balancers
+	// associated with this Domain.  This is used in automatic DNS provisioning like
+	// configuration of magic DNS or creating ExternalName services for cluster-local
+	// access.
+	LoadBalancers []LoadBalancerIngressSpec `json:"loadBalancers"`
+
+	// Configs contains additional pieces of information to configure ingress proxies.
+	// +optional
+	Configs []IngressConfig `json:"configs,omitempty"`
+}
+
+// IngressConfig allows KIngress implementations to add additional information needed
+// for configuring the proxies associated with this Domain.
+// For examples, in our Istio-based Ingress this will contains all references of
+// Istio Gateways associated with this Domain. This could be a reference of a ConfigMap
+// owned by the implementation as well.
+type IngressConfig struct {
+	// Name of the Kingress implementation resource
+	// +optional
+	Name string `json:"name,omitempty"`
+	// Namespace of the Kingress implementation resource
+	// +optional
+	Namespace string `json:"namespace,omitempty"`
+	// Type of the Kingress implementation resource
+	// +optional
+	Type string `json:"type,omitempty"`
+}
+
+// LoadBalancerIngressSpec represents the spec of a load-balancer ingress point:
+// traffic intended for the service should be sent to an ingress point.
+type LoadBalancerIngressSpec struct {
+	// IP is set for load-balancer ingress points that are IP based
+	// (typically GCE or OpenStack load-balancers)
+	// +optional
+	IP string `json:"ip,omitempty"`
+
+	// Domain is set for load-balancer ingress points that are DNS based
+	// (typically AWS load-balancers)
+	// +optional
+	Domain string `json:"domain,omitempty"`
+
+	// DomainInternal is set if there is a cluster-local DNS name to access the Ingress.
+	//
+	// NOTE: This differs from K8s Ingress, since we also desire to have a cluster-local
+	//       DNS name to allow routing in case of not having a mesh.
+	//
+	// +optional
+	DomainInternal string `json:"domainInternal,omitempty"`
+
+	// MeshOnly is set if the Ingress is only load-balanced through a Service mesh.
+	// +optional
+	MeshOnly bool `json:"meshOnly,omitempty"`
+}
+
+// DomainStatus will reflect Ready=True if the implementation accepts the Domain data
+// as valid.
+type DomainStatus struct {
+	duckv1.Status `json:",inline"`
+}
+
+// GetStatus retrieves the status of the Domain. Implements the KRShaped interface.
+func (d *Domain) GetStatus() *duckv1.Status {
+	return &d.Status.Status
+}