Moved full site from lauralorenz/sig-multicluster-site-proposal

Signed-off-by: Nicolas Pintaux <[email protected]>

Author: npintaux

.gitignore

@@ -0,0 +1 @@
+venv/

README.md

@@ -1,16 +1,6 @@
-# Kubernetes Template Project
+# SIG-Multicluster website
 
-The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files:
-
-- a `README.md` outlining the project goals, sponsoring sig, and community contact information
-- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
-- a `CONTRIBUTING.md` outlining how to contribute to the project
-- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code
-- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content
-- a `SECURITY_CONTACTS` with the contact points for the Product Security Team 
-  to reach out to for triaging and handling of incoming issues. They must agree to abide by the
-  [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy)
-  and will be removed and replaced if they violate that agreement.
+This repo holds and hosts the site for SIG-Multicluster, a special interest group of the Kubernetes project.
 
 ## Community, discussion, contribution, and support
 
@@ -27,3 +17,34 @@ Participation in the Kubernetes community is governed by the [Kubernetes Code of
 
 [owners]: https://git.k8s.io/community/contributors/guide/owners.md
 [Creative Commons 4.0]: https://git.k8s.io/website/LICENSE
+
+# Contributors
+
+## Install and run
+
+Install Python and the requirements.
+
+  ```
+    python3 -m venv venv/
+    source venv/bin/activate
+    pip install -r requirements.txt
+  ```
+
+Install the mkdocs plugins
+
+  ```
+  pip install mkdocs-awesome-pages-plugin
+  pip install mkdocs-macros-plugin
+  pip install mkdocs-redirects
+  ```
+Use the mkdocs CLI to serve a development version of the site.
+
+  ```mkdocs serve```
+
+Navigate to localhost:8000 to see the site.
+
+## Build and deploy
+
+Use the mkdocs CLI to deploy to the `gh-pages` branch of the repo.
+
+   ```mkdocs gh-deploy```

apis/doc.go

@@ -0,0 +1,17 @@
+/*
+Copyright 2020 The Kubernetes 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
+
+    http://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 apis

apis/service_export.go

@@ -0,0 +1,56 @@
+package apis
+
+// ServiceExport declares that the associated service should be exported to
+// other clusters.
+type ServiceExport struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+	// +optional
+	Status ServiceExportStatus `json:"status,omitempty"`
+}
+
+// ServiceExportStatus contains the current status of an export.
+type ServiceExportStatus struct {
+	// +optional
+	// +patchStrategy=merge
+	// +patchMergeKey=type
+	// +listType=map
+	// +listMapKey=type
+	Conditions []ServiceExportCondition `json:"conditions,omitempty"`
+}
+
+// ServiceExportConditionType identifies a specific condition.
+type ServiceExportConditionType string
+
+const {
+  // ServiceExportValid means that the service referenced by this
+  // service export has been recognized as valid by an mcs-controller.
+  // This will be false if the service is found to be unexportable
+  // (ExternalName, not found).
+  ServiceExportValid ServiceExportConditionType = "Valid"
+  // ServiceExportConflict means that there is a conflict between two
+  // exports for the same Service. When "True", the condition message
+  // should contain enough information to diagnose the conflict:
+  // field(s) under contention, which cluster won, and why.
+  // Users should not expect detailed per-cluster information in the
+  // conflict message.
+  ServiceExportConflict ServiceExportConditionType = "Conflict"
+}
+
+// ServiceExportCondition contains details for the current condition of this
+// service export.
+//
+// Once KEP-1623 (sig-api-machinery/1623-standardize-conditions) is
+// implemented, this will be replaced by metav1.Condition.
+type ServiceExportCondition struct {
+	Type ServiceExportConditionType `json:"type"`
+	// Status is one of {"True", "False", "Unknown"}
+	Status corev1.ConditionStatus `json:"status"`
+	// +optional
+	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
+	// +optional
+	Reason *string `json:"reason,omitempty"`
+	// +optional
+	Message *string `json:"message,omitempty"`
+}

apis/service_import.go

@@ -0,0 +1,81 @@
+package apis
+
+// ServiceImport describes a service imported from clusters in a clusterset.
+type ServiceImport struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+	// +optional
+	Spec ServiceImportSpec `json:"spec,omitempty"`
+	// +optional
+	Status ServiceImportStatus `json:"status,omitempty"`
+  }
+  
+  // ServiceImportType designates the type of a ServiceImport
+  type ServiceImportType string
+  
+  const (
+	// ClusterSetIP are only accessible via the ClusterSet IP.
+	ClusterSetIP ServiceImportType = "ClusterSetIP"
+	// Headless services allow backend pods to be addressed directly.
+	Headless ServiceImportType = "Headless"
+  )
+  
+  // ServiceImportSpec describes an imported service and the information necessary to consume it.
+  type ServiceImportSpec struct {
+	// +listType=atomic
+	Ports []ServicePort `json:"ports"`
+	// +kubebuilder:validation:MaxItems:=1
+	// +optional
+	IPs []string `json:"ips,omitempty"`
+	// +optional
+	Type ServiceImportType `json:"type"`
+	// +optional
+	SessionAffinity corev1.ServiceAffinity `json:"sessionAffinity"`
+	// +optional
+	SessionAffinityConfig *corev1.SessionAffinityConfig `json:"sessionAffinityConfig"`
+  }
+  
+  // ServicePort represents the port on which the service is exposed
+  type ServicePort struct {
+	// The name of this port within the service. This must be a DNS_LABEL.
+	// All ports within a ServiceSpec must have unique names. When considering
+	// the endpoints for a Service, this must match the 'name' field in the
+	// EndpointPort.
+	// Optional if only one ServicePort is defined on this service.
+	// +optional
+	Name string `json:"name,omitempty"`
+  
+	// The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
+	// Default is TCP.
+	// +optional
+	Protocol Protocol `json:"protocol,omitempty"`
+  
+	// The application protocol for this port.
+	// This field follows standard Kubernetes label syntax.
+	// Un-prefixed names are reserved for IANA standard service names (as per
+	// RFC-6335 and http://www.iana.org/assignments/service-names).
+	// Non-standard protocols should use prefixed names such as
+	// mycompany.com/my-custom-protocol.
+	// Field can be enabled with ServiceAppProtocol feature gate.
+	// +optional
+	AppProtocol *string `json:"appProtocol,omitempty"`
+  
+	// The port that will be exposed by this service.
+	Port int32 `json:"port"`
+  }
+  
+  // ServiceImportStatus describes derived state of an imported service.
+  type ServiceImportStatus struct {
+	// +optional
+	// +patchStrategy=merge
+	// +patchMergeKey=cluster
+	// +listType=map
+	// +listMapKey=cluster
+	Clusters []ClusterStatus `json:"clusters"`
+  }
+  
+  // ClusterStatus contains service configuration mapped to a specific source cluster
+  type ClusterStatus struct {
+   Cluster string `json:"cluster"`
+  }

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,57 @@
+site_name: SIG Multicluster
+repo_url: https://github.com/kubernetes-sigs/sig-multicluster-site
+repo_name: kubernetes-sigs/sig-multicluster-site
+site_dir: site
+docs_dir: site-src
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/git-alt
+  logo: images/k8s-favicon.png
+  favicon: images/k8s-favicon.png
+  features:
+    - search.highlight
+    - navigation.tabs
+    - navigation.top
+edit_uri: edit/main/site-src/
+plugins:
+  - search
+  - awesome-pages
+  - redirects:
+      redirect_maps:
+        'guides/getting-started.md': 'guides/index.md'
+        'contributing/community.md': 'contributing/index.md'
+markdown_extensions:
+  - admonition
+  - meta
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - pymdownx.snippets
+  - toc:
+      permalink: true
+nav:
+  - Overview:
+      Introduction: index.md
+      About API Overview: concepts/about-api.md
+      Multicluster Services API Overview: concepts/multicluster-services-api.md
+      Work API Overview: concepts/work-api.md
+  - Guides:
+    - Index: guides/index.md
+    - Implementation Guidelines: guides/guidelines.md
+  - Reference:
+    - Namespace Sameness: concepts/namespace-sameness.md
+    - ClusterSet: api-types/cluster-set.md
+    - ServiceExport: api-types/service-export.md
+    - ServiceImport: api-types/service-import.md
+    - API specification: references/spec.md
+  - Contributing:
+    - How to Get Involved: contributing/index.md
+    - FAQ: contributing/faq.md
+  - Announcements:
+    - Index: blog/index.md
+    - 2022:
+      - Archiving Kubefed on Jan 3rd, 2023: blog/2022/2022-11-16_archiving-kubefed-on-Jan-3-2023.md

requirements.txt

@@ -0,0 +1 @@
+mkdocs-material

site-src/api-types/cluster-set.md

@@ -0,0 +1,59 @@
+# ClusterSet
+
+ClusterSet represents a specific pattern implemented by various organizations. A ClusterSet is typically:
+
+- A group of clusters governed by a single authority.
+- There is usually a high degree of trust within the set of clusters.
+- [Namespace Sameness](../concepts/namespace-sameness.md) applies to clusters in the set:
+    - Permissions and characteristics are consistent across clusters for a given namespace.
+    - Namespaces don't have to exist in every cluster, but behave the same across those in which they do.
+
+!!!note
+        The early definition of the ClusterSet was described in [KEP-2149](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid). It is now part of the [About API](https://sigs.k8s.io/about-api).
+
+A cluster's ClusterSet membership is stored in the about.k8s.io/ClusterProperty `clusterset.k8s.io`.
+
+## Cluster Metadata
+The ClusterSet is a Cluster-scoped ClusterProperty CRD (Customer Resource Definition), that stores a name and a value. 
+
+This property can be used to:
+
+- uniquely identify clusters using a clusterID
+
+    ```
+    apiVersion: about.k8s.io/v1
+    kind: ClusterProperty
+    metadata:
+        name: cluster.clusterset.k8s.io
+    spec:
+        value: cluster-1
+    ```
+
+- uniquely identify the membership of a cluster in a ClusterSet for the lifetime of the membership.
+
+    ```
+    apiVersion: about.k8s.io/v1
+    kind: ClusterProperty
+    metadata:
+        name: clusterset.k8s.io
+    spec:
+        value: mycoolclusterset
+    ```
+    
+- Provide a reference point for multi-cluster tooling to build on within a cluster set, for example for DNS labels, for logging and tracing, etc.
+
+- Provide extra metadata space to store other cluster properties that might otherwise be implemented as ad-hoc annotations on semantically adjacent objects.
+
+    ```
+    apiVersion: about.k8s.io/v1
+    kind: ClusterProperty
+    metadata:
+        name: fingerprint.mycoolimplementation.com
+    spec:
+        value:  '{"major": "1","minor": "18","gitVersion": "v1.18.2","gitCommit": "52c56ce7a8272c798dbc29846288d7cd9fbae032","gitTreeState": "clean","buildDate": "2020-04-30T20:19:45Z","goVersion": "go1.13.9","compiler": "gc","platform": "linux/amd64"}'
+    ```
+
+
+
+
+

site-src/api-types/service-export.md

@@ -0,0 +1,14 @@
+# ServiceExport
+
+## Resource Definition
+A ServiceExport is a Customer Resource Definition used to specify which Kubernetes Services should be exported within a cluster.
+
+A ServiceExport resource is created with the cluster and namespace that a given Service resides in, and is name-mapped to the service for export. In other words, the ServiceExport is referenced with the same name as the export.
+
+If multiple clusters export a Service with the same namespaced name, they will be recognized as a single combined service.
+
+## DNS
+When a ServiceExport is created, this will cause a domain name for the multi-cluster service to become accessible from within the ClusterSet. The domain name will be `<service-export-name>.<service-export-namespace>.svc.clusterset.local`.
+
+## EndPointSlice
+When a ServiceExport is created, this will cause EndpointSlice objects for the underlying Service to be created in each cluster within the ClusterSet. One or more EndpointSlice resources will exist for each cluster that exported the Service, with each EndpointSlice containing only endpoints from its source cluster. These EndpointSlice objects are  marked as managed by the ClusterSet service controller, so that the endpoint slice controller doesn’t delete them.