Skip to content

Files

Latest commit

p-strusiewiczsurmacki-mobicaterassyi
p-strusiewiczsurmacki-mobica
and
terassyi
Standalone Egress NAT
Jan 22, 2025
edae8ae · Jan 22, 2025

History

History
182 lines (101 loc) · 6.16 KB

cni-grpc.md

File metadata and controls

182 lines (101 loc) · 6.16 KB

Protocol Documentation

Table of Contents

Top

pkg/cnirpc/cni.proto

AddResponse

AddResponse represents the response for ADD command.

result is a types.current.Result serialized into JSON. https://pkg.go.dev/github.com/containernetworking/cni@v0.8.0/pkg/types/current?tab=doc#Result

Field Type Label Description
result bytes

CNIArgs

CNIArgs is a mirror of cni.pkg.skel.CmdArgs struct. https://pkg.go.dev/github.com/containernetworking/cni@v0.8.0/pkg/skel?tab=doc#CmdArgs

Field Type Label Description
container_id string
netns string
ifname string
args CNIArgs.ArgsEntry repeated Key-Value pairs parsed from CNI_ARGS
path string
stdin_data bytes
ips string repeated
interfaces CNIArgs.InterfacesEntry repeated

CNIArgs.ArgsEntry

Field Type Label Description
key string
value string

CNIArgs.InterfacesEntry

Field Type Label Description
key string
value bool

CNIError

CNIError is a mirror of cin.pkg.types.Error struct. https://pkg.go.dev/github.com/containernetworking/cni@v0.8.0/pkg/types?tab=doc#Error

This should be added to *grpc.Status by WithDetails() https://pkg.go.dev/google.golang.org/grpc@v1.31.0/internal/status?tab=doc#Status.WithDetails

Field Type Label Description
code ErrorCode
msg string
details string

ErrorCode

ErrorCode enumerates errors for CNIError

Name Number Description
UNKNOWN 0
INCOMPATIBLE_CNI_VERSION 1
UNSUPPORTED_FIELD 2
UNKNOWN_CONTAINER 3
INVALID_ENVIRONMENT_VARIABLES 4
IO_FAILURE 5
DECODING_FAILURE 6
INVALID_NETWORK_CONFIG 7
TRY_AGAIN_LATER 11
INTERNAL 999

CNI

CNI implements CNI commands over gRPC.

Method Name Request Type Response Type Description
Add CNIArgs AddResponse
Del CNIArgs .google.protobuf.Empty
Check CNIArgs .google.protobuf.Empty

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)