ConsoleExternalLogLink [console.openshift.io/v1]
Description
ConsoleExternalLogLink is an extension for customizing OpenShift web console log links. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type
object
Required
spec
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 | |
|
| ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page. |
.spec
Description
ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page.
Type
object
Required
hrefTemplate
text
Property | Type | Description |
---|---|---|
|
| hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced. Variables are specified in the URL with the format ${variableName}, for instance, ${containerName} and will be replaced with the corresponding values from the resource. Resource is a pod. Supported variables are: - ${resourceName} - name of the resource which containes the logs - ${resourceUID} - UID of the resource which contains the logs - e.g. |
|
| namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., |
|
| text is the display text for the link |
API endpoints
The following API endpoints are available:
/apis/console.openshift.io/v1/consoleexternalloglinks
DELETE
: delete collection of ConsoleExternalLogLinkGET
: list objects of kind ConsoleExternalLogLinkPOST
: create a ConsoleExternalLogLink
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}
DELETE
: delete a ConsoleExternalLogLinkGET
: read the specified ConsoleExternalLogLinkPATCH
: partially update the specified ConsoleExternalLogLinkPUT
: replace the specified ConsoleExternalLogLink
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status
GET
: read status of the specified ConsoleExternalLogLinkPATCH
: partially update status of the specified ConsoleExternalLogLinkPUT
: replace status of the specified ConsoleExternalLogLink
/apis/console.openshift.io/v1/consoleexternalloglinks
HTTP method
DELETE
Description
delete collection of ConsoleExternalLogLink
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind ConsoleExternalLogLink
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLinkList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create a ConsoleExternalLogLink
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 |
---|---|---|
| ConsoleExternalLogLink schema |
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLink schema |
201 - Created | ConsoleExternalLogLink schema |
202 - Accepted | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the ConsoleExternalLogLink |
HTTP method
DELETE
Description
delete a ConsoleExternalLogLink
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 ConsoleExternalLogLink
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified ConsoleExternalLogLink
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 | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified ConsoleExternalLogLink
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 |
---|---|---|
| ConsoleExternalLogLink schema |
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLink schema |
201 - Created | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the ConsoleExternalLogLink |
HTTP method
GET
Description
read status of the specified ConsoleExternalLogLink
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified ConsoleExternalLogLink
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 | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified ConsoleExternalLogLink
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 |
---|---|---|
| ConsoleExternalLogLink schema |
HTTP code | Reponse body |
---|---|
200 - OK | ConsoleExternalLogLink schema |
201 - Created | ConsoleExternalLogLink schema |
401 - Unauthorized | Empty |