Shared Resource

Background

In KubeVela, by default, application owns resources. It means that resources create by the application should only be controlled by the application that creates it.

So there are basically two requirements for application creating resources:

  1. The resource must not exist before the application creating it. It exists, there will be a resource conflict error.
  2. The resource is expected to be only manageable through its creator. Others should not be able to modify it or edit it.

While dispatching resources, the application will

  1. Check if resource exists. If exists, check its labels. If app.oam.dev/name and app.oam.dev/namespace equals to the application’s name and namespace, it means this resource is previously created by the same application and the dispatching operation now will become an update operation. The two labels identify the owner of the resource.
  2. If resource exists, but no label found, then this resource is created before this application. At this time, the application will report a resource conflict error.
  3. If resource exists, and the labels point to another application, then this resource is managed by other applications. At this time, the current application will also report a resource conflict error. With these checks, different applications cannot manage the same resource.

Usage

However, there are scenarios that these two requirements are not met. One of the scenarios is sharing across different Applications.

For example, each application wants to create a ConfigMap, but their ConfigMaps are the same.

To achieve that, KubeVela application could utilize the shared-resource policy to make it possible.

create

When one resource is created as sharing resource, one special annotation app.oam.dev/shared-by will be added to the resource. It will record the sharer of the resource in time order. The application that firstly creates the resource will set its owner labels to itself.

Then it will add itself to the sharer annotation.

share

When another application comes and wants to share the resource, it will check if the resource is sharable, aka there is at least one sharer in the sharer annotation.

If it is sharable, it will add itself to the sharer annotation, but not modify the content of the resource.

delete

With this mechanism, only the owner of the resource can modify the resource (including updating and state-keeping). Other sharer can only see that resource.

When the owner of the resource is gone (application is deleted or do not use this resource anymore), it will give the owner of the application to the next sharer. If no sharer exists, it will finally delete that resource.

See the following figures for details.

shared-resource-1

shared-resource-2

Example

  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. metadata:
  4.   name: app1
  5. spec:
  6.   components:
  7.     - name: ns1
  8.       type: k8s-objects
  9.       properties:
  10.         objects:
  11.           - apiVersion: v1
  12.             kind: Namespace
  13.             metadata:
  14.               name: example
  15.     - name: cm1
  16.       type: k8s-objects
  17.       properties:
  18.         objects:
  19.           - apiVersion: v1
  20.             kind: ConfigMap
  21.             metadata:
  22.               name: cm1
  23.               namespace: example
  24.             data:
  25.               key: value1
  26.   policies:
  27.     - name: shared-resource
  28.       type: shared-resource
  29.       properties:
  30.         rules:
  31.           - selector:
  32.               resourceTypes: ["Namespace"]
  1. apiVersion: core.oam.dev/v1beta1
  2. kind: Application
  3. metadata:
  4.   name: app2
  5. spec:
  6.   components:
  7.     - name: ns2
  8.       type: k8s-objects
  9.       properties:
  10.         objects:
  11.           - apiVersion: v1
  12.             kind: Namespace
  13.             metadata:
  14.               name: example
  15.     - name: cm2
  16.       type: k8s-objects
  17.       properties:
  18.         objects:
  19.           - apiVersion: v1
  20.             kind: ConfigMap
  21.             metadata:
  22.               name: cm2
  23.               namespace: example
  24.             data:
  25.               key: value2
  26.   policies:
  27.     - name: shared-resource
  28.       type: shared-resource
  29.       properties:
  30.         rules:
  31.           - selector:
  32.               resourceTypes: ["Namespace"]

The above two applications will dispatch the same namespace “example”. They will create two different ConfigMap inside namespace “example” respectively.

Both application use the shared-resource policy and declared the namespace resource as shared. In this way, there will be no conflict for creating the same namespace. If the shared-resource policy is not used, the second application will report error after it finds that the namespace “example” is managed by the first application.

The namespace will only be recycled when both applications are removed.

Notice

  1. When multiple applications share the same resource, the first one who creates it can make updates to its content. The others cannot modify it. Once the first application does not use it anymore (for example, the first application is deleted), then the second one will become the owner, which means it is now able to modify the content. This will not take effect immediately. But when StateKeep happens, or application re-runs its workflow (for example, it is updated), it will set the resource content to be its desired state.

  2. Although shared-resource policy allows you to share resources across Applications, it does not guarantee the outside system can behave proper to coordinate with the shared resource, which may sometimes lead to unexpected results. For example, if you have two applications share the same namespace, it is fine for those applications to use this namespace. But if you manually create other resources into that namespace, once those two applications are gone, the namespace will be recycled automatically, and then your manually created resources in that namespace will be deleted as well, even if you do not intend to do that.