Start wiring example for VMs

Author: mjudeikis

config/examples/virtualresources/README.md

@@ -0,0 +1,55 @@
+# VirtualResources Example
+
+This example shows usage of VirtualResources, together with CachedResources.
+The goal of VirtualResources is to distribute static, read-only resources to multiple clusters
+in a scalable way.
+
+## Setup
+
+1. Start kcp with sharded setup:
+
+   ```bash
+   make test-run-sharded-server
+   ```
+
+2. Create a provider workspace, where we will create the resources to be distributed:
+
+   ```bash
+   export KUBECONFIG=.kcp/admin.kubeconfig
+   kubectl ws create provider --enter
+
+   kubectl create -f config/examples/virtualresources/crd-instances.yaml
+   # this this to work we always require apiresource schema to be present
+   kubectl create -f config/examples/virtualresources/apiresourceschema-instances.yaml
+   kubectl create -f config/examples/virtualresources/instances.yaml
+
+   # create caching for the resources
+   kubectl create -f config/examples/virtualresources/cached-resource-instances.yaml
+   ```
+
+3. Create a an APIResourceSchema for actual virtual machines to be distributed,
+   which will be using instance types. 
+
+   ```bash
+    kubectl create -f config/examples/virtualresources/apiresourceschema-virtualmachine.yaml
+   ```
+
+4. Create an APIExport for the virtual machines:
+
+    ```bash
+    kubectl create -f config/examples/virtualresources/apiexport.yaml
+   ```
+
+5. Create a consumer workspace, where we will consume the virtual machines:
+
+    ```bash
+    kubectl ws use :root
+    kubectl ws create consumer --enter
+    kubectl kcp bind apiexport root:provider:virtualmachines virtualmachines
+   ```
+
+6. Now check if we can see instances in the consumer workspace:
+
+   ```bash
+   kubectl get instances.machines.svm.io
+   ```

config/examples/virtualresources/apiexport.yaml

@@ -0,0 +1,21 @@
+apiVersion: apis.kcp.io/v1alpha2
+kind: APIExport
+metadata:
+  name: virtualmachines
+spec:
+  resources:
+  - name: instances
+    group: machines.svm.io
+    schema: today.instances.machines.svm.io
+    storage:
+      virtual:
+        reference:
+          apiGroup: cache.kcp.io
+          kind: CachedResourceEndpointSlice
+          name: instances
+        identityHash: 2857921554ab76ec50f25bf083b7aeb4f7808cd169fd2945b007429f426614ec
+  - name: virtualmachines
+    group: machines.svm.io
+    schema: today.virtualmachines.machines.svm.io
+    storage:
+      crd: {}

config/examples/virtualresources/apiresourceschema-instances.yaml

@@ -0,0 +1,88 @@
+apiVersion: apis.kcp.io/v1alpha1
+kind: APIResourceSchema
+metadata:
+  name: today.instances.machines.svm.io
+spec:
+  group: machines.svm.io
+  names:
+    kind: Instance
+    listKind: InstanceList
+    plural: instances
+    singular: instance
+    shortNames:
+    - inst
+  scope: Cluster
+  versions:
+  - name: v1alpha1
+    schema:
+      description: Instance represents a virtual machine instance
+      properties:
+        apiVersion:
+          description: 'APIVersion defines the versioned schema of this representation
+            of an object. Servers should convert recognized schemas to the latest
+            internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+          type: string
+        kind:
+          description: 'Kind is a string value representing the REST resource this
+            object represents. Servers may infer this from the endpoint the client
+            submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+          type: string
+        metadata:
+          type: object
+        spec:
+          description: InstanceSpec holds the desired state of the Instance.
+          properties:
+            instanceType:
+              description: The type of the instance (e.g. small, medium, large)
+              type: string
+            name:
+              description: The name of the instance
+              type: string
+            tier:
+              description: The tier of the instance (e.g. basic, premium)
+              type: string
+              enum:
+              - basic
+              - premium
+              - enterprise
+          required:
+          - instanceType
+          - name
+          - tier
+          type: object
+        status:
+          description: InstanceStatus communicates the observed state of the Instance.
+          properties:
+            phase:
+              description: The current phase of the instance
+              type: string
+              enum:
+              - Pending
+              - Running
+              - Terminated
+            conditions:
+              description: Current conditions of the instance
+              items:
+                properties:
+                  type:
+                    type: string
+                  status:
+                    type: string
+                  lastTransitionTime:
+                    type: string
+                    format: date-time
+                  reason:
+                    type: string
+                  message:
+                    type: string
+                required:
+                - type
+                - status
+                type: object
+              type: array
+          type: object
+      type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

config/examples/virtualresources/apiresourceschema-virtualmachine.yaml

@@ -0,0 +1,78 @@
+apiVersion: apis.kcp.io/v1alpha1
+kind: APIResourceSchema
+metadata:
+  name: today.virtualmachines.machines.svm.io
+spec:
+  group: machines.svm.io
+  names:
+    kind: VirtualMachine
+    listKind: VirtualMachineList
+    plural: virtualmachines
+    singular: virtualmachine
+  scope: Namespaced
+  versions:
+  - name: v1alpha1
+    schema:
+      description: VirtualMachine represents a virtual machine instance
+      properties:
+        apiVersion:
+          description: 'APIVersion defines the versioned schema of this representation
+            of an object. Servers should convert recognized schemas to the latest
+            internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+          type: string
+        kind:
+          description: 'Kind is a string value representing the REST resource this
+            object represents. Servers may infer this from the endpoint the client
+            submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+          type: string
+        metadata:
+          type: object
+        spec:
+          description: VirtualMachineSpec holds the desired state of the VirtualMachine.
+          properties:
+            instanceRef:
+              description: Reference to an Instance resource
+              properties:
+                name:
+                  description: Name of the Instance resource
+                  type: string
+                namespace:
+                  description: Namespace of the Instance resource
+                  type: string
+              required:
+              - name
+              type: object
+          required:
+          - instanceRef
+          type: object
+        status:
+          description: VirtualMachineStatus communicates the observed state of the VirtualMachine.
+          properties:
+            phase:
+              description: Current phase of the virtual machine
+              type: string
+            conditions:
+              description: Current conditions of the virtual machine
+              items:
+                properties:
+                  type:
+                    type: string
+                  status:
+                    type: string
+                  lastTransitionTime:
+                    type: string
+                  reason:
+                    type: string
+                  message:
+                    type: string
+                required:
+                - type
+                - status
+                type: object
+              type: array
+          type: object
+      type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}