IPPool [whereabouts.cni.cncf.io/v1alpha1]
Description
IPPool is the Schema for Whereabouts for IP address allocation
Type
object
Specification
Property | Type | Description |
---|---|---|
|
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| IPPoolSpec defines the desired state of IPPool |
.spec
Description
IPPoolSpec defines the desired state of IPPool
Type
object
Required
allocations
range
Property | Type | Description |
---|---|---|
|
| Allocations is the set of allocated IPs for the given range. Its indices are a direct mapping to the IP with the same index/offset for the pool’s range. |
|
| IPAllocation represents metadata about the pod/container owner of a specific IP |
|
| Range is a RFC 4632/4291-style string that represents an IP address and prefix length in CIDR notation |
.spec.allocations
Description
Allocations is the set of allocated IPs for the given range. Its indices are a direct mapping to the IP with the same index/offset for the pool’s range.
Type
object
.spec.allocations{}
Description
IPAllocation represents metadata about the pod/container owner of a specific IP
Type
object
Required
id
Property | Type | Description |
---|---|---|
|
| |
|
|
API endpoints
The following API endpoints are available:
/apis/whereabouts.cni.cncf.io/v1alpha1/ippools
GET
: list objects of kind IPPool
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools
DELETE
: delete collection of IPPoolGET
: list objects of kind IPPoolPOST
: create an IPPool
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools/{name}
DELETE
: delete an IPPoolGET
: read the specified IPPoolPATCH
: partially update the specified IPPoolPUT
: replace the specified IPPool
/apis/whereabouts.cni.cncf.io/v1alpha1/ippools
HTTP method
GET
Description
list objects of kind IPPool
HTTP code | Reponse body |
---|---|
200 - OK | IPPoolList schema |
401 - Unauthorized | Empty |
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools
HTTP method
DELETE
Description
delete collection of IPPool
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind IPPool
HTTP code | Reponse body |
---|---|
200 - OK | IPPoolList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create an IPPool
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| IPPool schema |
HTTP code | Reponse body |
---|---|
200 - OK | IPPool schema |
201 - Created | IPPool schema |
202 - Accepted | IPPool schema |
401 - Unauthorized | Empty |
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the IPPool |
HTTP method
DELETE
Description
delete an IPPool
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified IPPool
HTTP code | Reponse body |
---|---|
200 - OK | IPPool schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified IPPool
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
HTTP code | Reponse body |
---|---|
200 - OK | IPPool schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified IPPool
Parameter | Type | Description |
---|---|---|
|
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
Parameter | Type | Description |
---|---|---|
| IPPool schema |
HTTP code | Reponse body |
---|---|
200 - OK | IPPool schema |
201 - Created | IPPool schema |
401 - Unauthorized | Empty |