...

Text file src/k8s.io/api/networking/v1alpha1/generated.proto

Documentation: k8s.io/api/networking/v1alpha1

     1/*
     2Copyright The Kubernetes Authors.
     3
     4Licensed under the Apache License, Version 2.0 (the "License");
     5you may not use this file except in compliance with the License.
     6You may obtain a copy of the License at
     7
     8    http://www.apache.org/licenses/LICENSE-2.0
     9
    10Unless required by applicable law or agreed to in writing, software
    11distributed under the License is distributed on an "AS IS" BASIS,
    12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13See the License for the specific language governing permissions and
    14limitations under the License.
    15*/
    16
    17
    18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
    19
    20syntax = "proto2";
    21
    22package k8s.io.api.networking.v1alpha1;
    23
    24import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
    25import "k8s.io/apimachinery/pkg/runtime/generated.proto";
    26import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
    27
    28// Package-wide variables from generator "generated".
    29option go_package = "k8s.io/api/networking/v1alpha1";
    30
    31// IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs
    32// that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses.
    33// An IP address can be represented in different formats, to guarantee the uniqueness of the IP,
    34// the name of the object is the IP address in canonical format, four decimal digits separated
    35// by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6.
    36// Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1
    37// Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
    38message IPAddress {
    39  // Standard object's metadata.
    40  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    41  // +optional
    42  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    43
    44  // spec is the desired state of the IPAddress.
    45  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    46  // +optional
    47  optional IPAddressSpec spec = 2;
    48}
    49
    50// IPAddressList contains a list of IPAddress.
    51message IPAddressList {
    52  // Standard object's metadata.
    53  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    54  // +optional
    55  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
    56
    57  // items is the list of IPAddresses.
    58  repeated IPAddress items = 2;
    59}
    60
    61// IPAddressSpec describe the attributes in an IP Address.
    62message IPAddressSpec {
    63  // ParentRef references the resource that an IPAddress is attached to.
    64  // An IPAddress must reference a parent object.
    65  // +required
    66  optional ParentReference parentRef = 1;
    67}
    68
    69// ParentReference describes a reference to a parent object.
    70message ParentReference {
    71  // Group is the group of the object being referenced.
    72  // +optional
    73  optional string group = 1;
    74
    75  // Resource is the resource of the object being referenced.
    76  // +required
    77  optional string resource = 2;
    78
    79  // Namespace is the namespace of the object being referenced.
    80  // +optional
    81  optional string namespace = 3;
    82
    83  // Name is the name of the object being referenced.
    84  // +required
    85  optional string name = 4;
    86}
    87
    88// ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64).
    89// This range is used to allocate ClusterIPs to Service objects.
    90message ServiceCIDR {
    91  // Standard object's metadata.
    92  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    93  // +optional
    94  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    95
    96  // spec is the desired state of the ServiceCIDR.
    97  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    98  // +optional
    99  optional ServiceCIDRSpec spec = 2;
   100
   101  // status represents the current state of the ServiceCIDR.
   102  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
   103  // +optional
   104  optional ServiceCIDRStatus status = 3;
   105}
   106
   107// ServiceCIDRList contains a list of ServiceCIDR objects.
   108message ServiceCIDRList {
   109  // Standard object's metadata.
   110  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   111  // +optional
   112  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   113
   114  // items is the list of ServiceCIDRs.
   115  repeated ServiceCIDR items = 2;
   116}
   117
   118// ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.
   119message ServiceCIDRSpec {
   120  // CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64")
   121  // from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family.
   122  // This field is immutable.
   123  // +optional
   124  // +listType=atomic
   125  repeated string cidrs = 1;
   126}
   127
   128// ServiceCIDRStatus describes the current state of the ServiceCIDR.
   129message ServiceCIDRStatus {
   130  // conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR.
   131  // Current service state
   132  // +optional
   133  // +patchMergeKey=type
   134  // +patchStrategy=merge
   135  // +listType=map
   136  // +listMapKey=type
   137  repeated k8s.io.apimachinery.pkg.apis.meta.v1.Condition conditions = 1;
   138}
   139

View as plain text