Skip to content

Latest commit

 

History

History
314 lines (255 loc) · 12 KB

pouch_cri_api_changelog.md

File metadata and controls

314 lines (255 loc) · 12 KB

CRI API CHANGELOG

Overview

Because the CRI interface of Kubernetes cannot meet the customized development of Kubelet at present, it is necessary to provide the required functions of Kubelet by extending the API of CRI. On top of CRI's existing functionality, use the field extension or add method to make CRI meet the requirements.

Kubernetes Version: V1.10.0+

Requirements

  1. Support the ability to update the container diskquota.
    • Scenario:
      • Limits the directory size within the container.
  2. Support the ability to acquire the volumes of the Image.
    • Scenario:
      • In the Upgrade process, the volumes and mountpoints of the old container need to be read. At the same time, the volumes in the new image also need to be read. If the mount point is the same, the volumes in the new image cover the volumes in the old container.
  3. Support to the ability to acquire the volumes of the Container.
    • Scenario:
      • In the Upgrade process, the volumes of the new container needs to remain consistent with that of the old container, so the volumes of the old container needs to be read.
  4. Support to the ability to acquire the envs of the Container.
    • Scenario:
      • In the Upgrade process, the env of the new container needs to remain consistent with that of the old container, so the envs of the old container needs to be read.

The Changes Of CRI API

UpdateContainerResources

What To Solve?

  1. Support the ability to update the container quotadir.

Modification

  • Add the DiskQuota field in LinuxContainerResources, referring to the definition of Resources in moby for better compatibility. The new fields are as follows:
type LinuxContainerResources struct {
    ......
    //***New Fields***//
    // DiskQuota constrains the disk. Default: none (not specified)
    DiskQuota map[string]string `protobuf:"bytes,100,req,name=disk_quota,json=diskQuota,proto3" json:"disk_quota,omitempty"`
    // Block IO weight (relative weight vs. other containers)
    BlkioWeight          uint16            `protobuf:"bytes,101,opt,name=blkio_weight,json=blkioWeight,proto3" json:"blkio_weight,omitempty"`
    BlkioWeightDevice    []*WeightDevice   `protobuf:"bytes,102,req,name=blkio_weight_device,json=blkioWeightDevice,proto3" json:"blkio_weight_device,omitempty"`
    BlkioDeviceReadBps   []*ThrottleDevice `protobuf:"bytes,103,req,name=blkio_device_read_bps,json=blkioDeviceReadBps,proto3" json:"blkio_device_read_bps,omitempty"`
    BlkioDeviceWriteBps  []*ThrottleDevice `protobuf:"bytes,104,req,name=blkio_device_write_bps,json=blkioDeviceWriteBps,proto3" json:"blkio_device_write_bps,omitempty"`
    BlkioDeviceReadIOps  []*ThrottleDevice `protobuf:"bytes,105,req,name=blkio_device_read_IOps,json=blkioDeviceReadIOps,proto3" json:"blkio_device_read_IOps,omitempty"`
    BlkioDeviceWriteIOps []*ThrottleDevice `protobuf:"bytes,106,req,name=blkio_device_write_IOps,json=blkioDeviceWriteIOps,proto3" json:"blkio_device_write_IOps,omitempty"`
    // Kernel memory limit (in bytes)
    KernelMemory int64 `protobuf:"bytes,107,opt,name=kernel_memory,json=kernelMemory,proto3" json:"kernel_memory,omitempty"`
    // Memory soft limit (in bytes)
    MemoryReservation int64 `protobuf:"bytes,108,opt,name=memory_reservation,json=memoryReservation,proto3" json:"memory_reservation,omitempty"`
    // Tuning container memory swappiness behaviour
    MemorySwappiness int64 `protobuf:"bytes,109,opt,name=memory_swappiness,json=memorySwappiness,proto3" json:"memory_swappiness,omitempty"`
    // List of ulimits to be set in the container
    Ulimits []*Ulimit `protobuf:"bytes,110,opt,name=ulimits,json=ulimits,proto3" json:"ulimits,omitempty"`
}

// WeightDevice is a structure that holds device:weight pair
type WeightDevice struct {
    // Path of weightdevice. 
    Path string `protobuf:"bytes,1,opt,name=path,json=path,proto3" json:"path,omitempty"`
    // Weight of weightdevice. 
    Weight uint16 `protobuf:"bytes,2,opt,name=weight,json=weight,proto3" json:"weight,omitempty"`
}

// ThrottleDevice is a structure that holds device:rate_per_second pair
type ThrottleDevice struct {
    // Path of throttledevice.
    Path string `protobuf:"bytes,1,opt,name=path,json=path,proto3" json:"path,omitempty"`
    // Rate of throttledevice.
    Rate uint64 `protobuf:"bytes,1,opt,name=rate,json=rate,proto3" json:"rate,omitempty"`
}

// Ulimit is a human friendly version of Rlimit.
type Ulimit struct {
    // Name of ulimit.
    Name string `protobuf:"bytes,1,opt,name=name,json=name,proto3" json:"name,omitempty"`
    // Hard of ulimit. 
    Hard int64 `protobuf:"bytes,2,opt,name=hard,json=hard,proto3" json:"hard,omitempty"`
    // Soft of Ulimit.
    Soft int64 `protobuf:"bytes,3,opt,name=soft,json=soft,proto3" json:"soft,omitempty"`
}

The changes need to be made in the proto file are as follows:

message LinuxContainerResources {
    ......
    //***New Fields***//
    // DiskQuota constrains the disk
    map<string,string> disk_quota = 100;
    // Block IO weight (relative weight vs. other containers)
    uint32  blkio_weight = 101;
    repeated WeightDevice blkio_weight_device = 102;
    repeated ThrottleDevice blkio_device_read_bps = 103;
    repeated ThrottleDevice blkio_device_write_bps = 104;
    repeated ThrottleDevice blkio_device_read_IOps = 105;
    repeated ThrottleDevice blkio_device_write_IOps = 106;
    // Kernel memory limit (in bytes)
    int64 kernel_memory = 107;
    // Memory soft limit (in bytes)
    int64 memory_reservation = 108;
    // Tuning container memory swappiness behaviour
    Int64Value memory_swappiness = 109;
    // List of ulimits to be set in the container
    repeated Ulimit ulimits = 110;
}

// WeightDevice is a structure that holds device:weight pair
message WeightDevice {
    // Path of weightdevice.
    string path = 1;
    // Weight of weightdevice.
    uint32 Weight = 2;
}

// ThrottleDevice is a structure that holds device:rate_per_second pair
message ThrottleDevice  {
    // Path of throttledevice.
    string path = 1;
    // Rate of throttledevice.
    uint64 rate = 2;
}

//  Ulimit is a human friendly version of Rlimit.
message Ulimit {
    // Name of ulimit.
    string name = 1;
    // Hard limit of ulimit.
    int64 hard = 2;
    // Soft limit of Ulimit.
    int64 soft = 3;
}

ContainerStatus

What To Solve?

  • Support to the ability to acquire the volumes of the Container.
  • Support to the ability to acquire the Resource of the Container.
  • Pass the quotaID generated when the container is created for disk reuse.
  • Support to the ability to acquire the envs of the Container.

Modification

  • The ContainerStatus struct is used only in ContainerStatusResponse in CRI, so the volumes of the container can be obtained by directly adding volume field to the ContainerStatus struct.
  • Add Resources field to support the retrieval of container's resource.
  • When get ContainerStatus, the return object of ContainerStatusResponse will contain the field of QuotaId .
  • When get ContainerStatus, the return object of ContainerStatusResponse will contain the field of Envs .
// ContainerStatus represents the status of a container.
type ContainerStatus struct {
    ......
    //***New Fields***//
    // Volumes of container
    Volumes map[string]struct{} `protobuf:"bytes,100,opt,name=volumes,json=volumes" json:"volumes,omitempty"`
    // Resources specification for the container
    Resources *LinuxContainerResources `protobuf:"bytes,101,opt,name=resources" json:"resources,omitempty"` 
    // QuotaId of the container
    QuotaId string `protobuf:"bytes,102,opt,name=quota_id,json=quotaId,proto3" json:"quota_id,omitempty"`
    // List of environment variable to set in the container.
    Envs []*KeyValue `protobuf:"bytes,103,rep,name=envs" json:"envs,omitempty"`
}

The changes need to be made in the proto file are as follows:

// ContainerStatus represents the status of a container.
message ContainerStatus {
    ......
    //***New Fields***//
    // Volumes of container
    map<string,  Volume> volumes= 100;
    // Resources specification for the container
    LinuxContainerResources resources = 101;
    // QuotaId of the container
    string quota_id = 102;
    // List of environment variable to set in the container.
    repeated KeyValue envs = 103;
}

message Volume {
}

ImageStatus

What To Solve?

  • Support the ability to acquire the volumes of the Image.

Modification

  • Add volumes field in the Image struct.
// Basic information about a container image.
type Image struct {
    ......
    //***New Fields***//
    // Volumes of image
    Volumes map[string]struct{} `protobuf:"bytes,7,opt,name=volumes,json=volumes" json:"volumes,omitempty"`
}

The changes need to be made in the proto file are as follows:

// Basic information about a container image.
message Image {
    ......
    //***New Fields***//
    // Volumes of image
    map<string, Volume> volumes= 100;
}

CreateContainer

What To Solve?

  • Support the ability to set DiskQuota.
  • Add missing fields.

Modification

  • LinuxContainerConfig contains LinuxContainerResources, which have changed in UpdateContainerResources().So after changing LinuxContainerResources, the Create process already supports the setting of DiskQuota.
  • For missing fields are as follows (not all):
    • NetPriority : Set network priorities
  • QuotaId : When creating container, pass parameters of the DiskQuota and QuotaId. (When QuotaId is -1, QuotaId will be automatically generated)
type ContainerConfig struct {
    ......
    //***New Fields***//
    // NetPriority of the container
    NetPriority int64 `protobuf:"bytes,100,opt,name=net_priority" json:"net_priority,omitempty"` 
    // QuotaId of the container
    QuotaId string `protobuf:"bytes,101,opt,name=quota_id,json=quotaId,proto3" json:"quota_id,omitempty"`
}

The changes need to be made in the proto file are as follows:

message ContainerConfig {
    ......
    //***New Fields***//
    // NetPriority of the containeri
    int64  net_priority = 100;
    // QuotaId of the container
    string quota_id = 101;
}

RemoveVolume

What To Solve?

  • After kubelet performs upgrade, the container upgraded cannot delete the anonymous volume inherited.

Modification

  • Provides an interface for removing volume.
  • The containerstatus interface supports querying volume by name.
  • The changes need to be made in the proto file are as follows:
service VolumeService {
 ​   // RemoveVolume volume an volume 
    rpc RemoveVolume(RemoveVolumeRequest) returns (RemoveVolumeResponse) {}
}​

message RemoveVolumeRequest {
    // name of the volume to remove
    string volume_name = 1;
}
message RemoveVolumeResponse {}

Add name field in the Mount struct:

// Mount specifies a host volume to mount into a container.
message Mount {
    ......
    //***New Fields***//
    // Name of volume
    string name = 100;  
}

Pull Request

  • feature: extend cri apis for special needs #1617
  • feature: extend cri apis for remove volume #2124
  • feature: extend cri apis for support quotaID #2138