github.com/cilium/cilium@v1.16.2/api/v1/peer/README.md (about)

     1  # Protocol Documentation
     2  <a name="top"></a>
     3  
     4  ## Table of Contents
     5  
     6  - [peer/peer.proto](#peer_peer-proto)
     7      - [ChangeNotification](#peer-ChangeNotification)
     8      - [NotifyRequest](#peer-NotifyRequest)
     9      - [TLS](#peer-TLS)
    10    
    11      - [ChangeNotificationType](#peer-ChangeNotificationType)
    12    
    13      - [Peer](#peer-Peer)
    14    
    15  - [Scalar Value Types](#scalar-value-types)
    16  
    17  
    18  
    19  <a name="peer_peer-proto"></a>
    20  <p align="right"><a href="#top">Top</a></p>
    21  
    22  ## peer/peer.proto
    23  
    24  
    25  
    26  <a name="peer-ChangeNotification"></a>
    27  
    28  ### ChangeNotification
    29  ChangeNotification indicates a change regarding a hubble peer.
    30  
    31  
    32  | Field | Type | Label | Description |
    33  | ----- | ---- | ----- | ----------- |
    34  | name | [string](#string) |  | Name is the name of the peer, typically the hostname. The name includes the cluster name if a value other than default has been specified. This value can be used to uniquely identify the host. When the cluster name is not the default, the cluster name is prepended to the peer name and a forward slash is added.
    35  
    36  Examples: - runtime1 - testcluster/runtime1 |
    37  | address | [string](#string) |  | Address is the address of the peer&#39;s gRPC service. |
    38  | type | [ChangeNotificationType](#peer-ChangeNotificationType) |  | ChangeNotificationType indicates the type of change, ie whether the peer was added, deleted or updated. |
    39  | tls | [TLS](#peer-TLS) |  | TLS provides information to connect to the Address with TLS enabled. If not set, TLS shall be assumed to be disabled. |
    40  
    41  
    42  
    43  
    44  
    45  
    46  <a name="peer-NotifyRequest"></a>
    47  
    48  ### NotifyRequest
    49  
    50  
    51  
    52  
    53  
    54  
    55  
    56  <a name="peer-TLS"></a>
    57  
    58  ### TLS
    59  TLS provides information to establish a TLS connection to the peer.
    60  
    61  
    62  | Field | Type | Label | Description |
    63  | ----- | ---- | ----- | ----------- |
    64  | server_name | [string](#string) |  | ServerName is used to verify the hostname on the returned certificate. |
    65  
    66  
    67  
    68  
    69  
    70   
    71  
    72  
    73  <a name="peer-ChangeNotificationType"></a>
    74  
    75  ### ChangeNotificationType
    76  ChangeNotificationType defines the peer change notification type.
    77  
    78  | Name | Number | Description |
    79  | ---- | ------ | ----------- |
    80  | UNKNOWN | 0 |  |
    81  | PEER_ADDED | 1 |  |
    82  | PEER_DELETED | 2 |  |
    83  | PEER_UPDATED | 3 |  |
    84  
    85  
    86   
    87  
    88   
    89  
    90  
    91  <a name="peer-Peer"></a>
    92  
    93  ### Peer
    94  Peer lists  hubble peers and notifies of changes.
    95  
    96  | Method Name | Request Type | Response Type | Description |
    97  | ----------- | ------------ | ------------- | ------------|
    98  | Notify | [NotifyRequest](#peer-NotifyRequest) | [ChangeNotification](#peer-ChangeNotification) stream | Notify sends information about hubble peers in the cluster. When Notify is called, it sends information about all the peers that are already part of the cluster (with the type as PEER_ADDED). It subsequently notifies of any change. |
    99  
   100   
   101  
   102  
   103  
   104  ## Scalar Value Types
   105  
   106  | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
   107  | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
   108  | <a name="double" /> double |  | double | double | float | float64 | double | float | Float |
   109  | <a name="float" /> float |  | float | float | float | float32 | float | float | Float |
   110  | <a name="int32" /> 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) |
   111  | <a name="int64" /> 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 |
   112  | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
   113  | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
   114  | <a name="sint32" /> 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) |
   115  | <a name="sint64" /> 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 |
   116  | <a name="fixed32" /> 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) |
   117  | <a name="fixed64" /> 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 |
   118  | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
   119  | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
   120  | <a name="bool" /> bool |  | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
   121  | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
   122  | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
   123