Chapter 7. DNSNameResolver [network.openshift.io/v1alpha1]
- Description
DNSNameResolver stores the DNS name resolution information of a DNS name. It can be enabled by the TechPreviewNoUpgrade feature set. It can also be enabled by the feature gate DNSNameResolver when using CustomNoUpgrade feature set.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
- Type
-
object - Required
-
spec
-
7.1. Specification Copy linkLink copied to clipboard!
| 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 | |
|
|
| spec is the specification of the desired behavior of the DNSNameResolver. |
|
|
| status is the most recently observed status of the DNSNameResolver. |
7.1.1. .spec Copy linkLink copied to clipboard!
- Description
- spec is the specification of the desired behavior of the DNSNameResolver.
- Type
-
object - Required
-
name
-
| Property | Type | Description |
|---|---|---|
|
|
| name is the DNS name for which the DNS name resolution information will be stored. For a regular DNS name, only the DNS name resolution information of the regular DNS name will be stored. For a wildcard DNS name, the DNS name resolution information of all the DNS names that match the wildcard DNS name will be stored. For a wildcard DNS name, the '' will match only one label. Additionally, only a single '' can be used at the beginning of the wildcard DNS name. For example, '*.example.com.' will match 'sub1.example.com.' but won’t match 'sub2.sub1.example.com.' |
7.1.2. .status Copy linkLink copied to clipboard!
- Description
- status is the most recently observed status of the DNSNameResolver.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| resolvedNames contains a list of matching DNS names and their corresponding IP addresses along with their TTL and last DNS lookup times. |
|
|
| DNSNameResolverResolvedName describes the details of a resolved DNS name. |
7.1.3. .status.resolvedNames Copy linkLink copied to clipboard!
- Description
- resolvedNames contains a list of matching DNS names and their corresponding IP addresses along with their TTL and last DNS lookup times.
- Type
-
array
7.1.4. .status.resolvedNames[] Copy linkLink copied to clipboard!
- Description
- DNSNameResolverResolvedName describes the details of a resolved DNS name.
- Type
-
object - Required
-
dnsName -
resolvedAddresses
-
| Property | Type | Description |
|---|---|---|
|
|
| conditions provide information about the state of the DNS name. Known .status.conditions.type is: "Degraded". "Degraded" is true when the last resolution failed for the DNS name, and false otherwise. |
|
|
| Condition contains details for one aspect of the current state of this API Resource. |
|
|
| dnsName is the resolved DNS name matching the name field of DNSNameResolverSpec. This field can store both regular and wildcard DNS names which match the spec.name field. When the spec.name field contains a regular DNS name, this field will store the same regular DNS name after it is successfully resolved. When the spec.name field contains a wildcard DNS name, each resolvedName.dnsName will store the regular DNS names which match the wildcard DNS name and have been successfully resolved. If the wildcard DNS name can also be successfully resolved, then this field will store the wildcard DNS name as well. |
|
|
| resolutionFailures keeps the count of how many consecutive times the DNS resolution failed for the dnsName. If the DNS resolution succeeds then the field will be set to zero. Upon every failure, the value of the field will be incremented by one. The details about the DNS name will be removed, if the value of resolutionFailures reaches 5 and the TTL of all the associated IP addresses have expired. |
|
|
| resolvedAddresses gives the list of associated IP addresses and their corresponding TTLs and last lookup times for the dnsName. |
|
|
| DNSNameResolverResolvedAddress describes the details of an IP address for a resolved DNS name. |
7.1.5. .status.resolvedNames[].conditions Copy linkLink copied to clipboard!
- Description
- conditions provide information about the state of the DNS name. Known .status.conditions.type is: "Degraded". "Degraded" is true when the last resolution failed for the DNS name, and false otherwise.
- Type
-
array
7.1.6. .status.resolvedNames[].conditions[] Copy linkLink copied to clipboard!
- Description
- Condition contains details for one aspect of the current state of this API Resource.
- Type
-
object - Required
-
lastTransitionTime -
message -
reason -
status -
type
-
| Property | Type | Description |
|---|---|---|
|
|
| lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
|
|
| message is a human readable message indicating details about the transition. This may be an empty string. |
|
|
| observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
|
|
| reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
|
|
| status of the condition, one of True, False, Unknown. |
|
|
| type of condition in CamelCase or in foo.example.com/CamelCase. |
7.1.7. .status.resolvedNames[].resolvedAddresses Copy linkLink copied to clipboard!
- Description
- resolvedAddresses gives the list of associated IP addresses and their corresponding TTLs and last lookup times for the dnsName.
- Type
-
array
7.1.8. .status.resolvedNames[].resolvedAddresses[] Copy linkLink copied to clipboard!
- Description
- DNSNameResolverResolvedAddress describes the details of an IP address for a resolved DNS name.
- Type
-
object - Required
-
ip -
lastLookupTime -
ttlSeconds
-
| Property | Type | Description |
|---|---|---|
|
|
| ip is an IP address associated with the dnsName. The validity of the IP address expires after lastLookupTime + ttlSeconds. To refresh the information, a DNS lookup will be performed upon the expiration of the IP address’s validity. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address’s validity. |
|
|
| lastLookupTime is the timestamp when the last DNS lookup was completed successfully. The validity of the IP address expires after lastLookupTime + ttlSeconds. The value of this field will be updated to the current time on a successful DNS lookup. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address’s validity. |
|
|
| ttlSeconds is the time-to-live value of the IP address. The validity of the IP address expires after lastLookupTime + ttlSeconds. On a successful DNS lookup the value of this field will be updated with the current time-to-live value. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address’s validity. |
7.2. API endpoints Copy linkLink copied to clipboard!
The following API endpoints are available:
/apis/network.openshift.io/v1alpha1/dnsnameresolvers-
GET: list objects of kind DNSNameResolver
-
/apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers-
DELETE: delete collection of DNSNameResolver -
GET: list objects of kind DNSNameResolver -
POST: create a DNSNameResolver
-
/apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers/{name}-
DELETE: delete a DNSNameResolver -
GET: read the specified DNSNameResolver -
PATCH: partially update the specified DNSNameResolver -
PUT: replace the specified DNSNameResolver
-
/apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers/{name}/status-
GET: read status of the specified DNSNameResolver -
PATCH: partially update status of the specified DNSNameResolver -
PUT: replace status of the specified DNSNameResolver
-
7.2.1. /apis/network.openshift.io/v1alpha1/dnsnameresolvers Copy linkLink copied to clipboard!
- HTTP method
-
GET - Description
- list objects of kind DNSNameResolver
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
7.2.2. /apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers Copy linkLink copied to clipboard!
- HTTP method
-
DELETE - Description
- delete collection of DNSNameResolver
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind DNSNameResolver
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a DNSNameResolver
| 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 |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
7.2.3. /apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers/{name} Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the DNSNameResolver |
- HTTP method
-
DELETE - Description
- delete a DNSNameResolver
| 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 |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified DNSNameResolver
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified DNSNameResolver
| 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 |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified DNSNameResolver
| 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 |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
7.2.4. /apis/network.openshift.io/v1alpha1/namespaces/{namespace}/dnsnameresolvers/{name}/status Copy linkLink copied to clipboard!
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the DNSNameResolver |
- HTTP method
-
GET - Description
- read status of the specified DNSNameResolver
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update status of the specified DNSNameResolver
| 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 |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace status of the specified DNSNameResolver
| 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 |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |