From 157b72a8b4dbc152a058ac78065d62e041c427c3 Mon Sep 17 00:00:00 2001 From: Kevin Owen Date: Fri, 16 Dec 2022 12:56:36 -0500 Subject: [PATCH] OSDOCS#4649: Copy relevant APIs for MicroShift, strip broken links --- _topic_maps/_topic_map_ms.yml | 2 +- .../route-route-openshift-io-v1.adoc | 1204 +++++++++++++++++ ...tconstraints-security-openshift-io-v1.adoc | 661 +++++++++ modules/microshift-k8s-apis.adoc | 6 +- modules/microshift-openshift-apis.adoc | 4 +- 5 files changed, 1871 insertions(+), 6 deletions(-) create mode 100644 microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc create mode 100644 microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 49f46000e3be..1a8ec3d673f8 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -57,7 +57,7 @@ Topics: File: microshift-install-rhel-for-edge --- Name: API reference -Dir: rest_api +Dir: microshift_rest_api Distros: microshift Topics: - Name: Network APIs diff --git a/microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc b/microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc new file mode 100644 index 000000000000..a3165a17636c --- /dev/null +++ b/microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc @@ -0,0 +1,1204 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="route-route-openshift-io-v1"] += Route [route.openshift.io/v1] +:toc: macro +:toc-title: + +toc::[] + + +Description:: ++ +-- +A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints. + +Once a route is created, the `host` field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts. + +Routers are subject to additional customization and may support additional controls via the annotations field. + +Because administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen. + +To enable HTTP/2 ALPN on a route it requires a custom (non-wildcard) certificate. This prevents connection coalescing by clients, notably web browsers. We do not support HTTP/2 ALPN on routes that use the default certificate because of the risk of connection re-use/coalescing. Routes that do not have their own custom certificate will not be HTTP/2 ALPN-enabled on either the frontend or the backend. + +Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +-- + +Type:: + `object` + +Required:: + - `spec` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `apiVersion` +| `string` +| 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` +| `string` +| 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 + +| `metadata` +| `ObjectMeta_v2` +| + +| `spec` +| `object` +| RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 100. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response. + +The `tls` field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate. + +| `status` +| `object` +| RouteStatus provides relevant info about the status of a route, including which routers acknowledge it. + +|=== +=== .spec +Description:: ++ +-- +RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 100. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response. + +The `tls` field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate. +-- + +Type:: + `object` + +Required:: + - `to` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `alternateBackends` +| `array` +| alternateBackends allows up to 3 additional backends to be assigned to the route. Only the Service kind is allowed, and it will be defaulted to Service. Use the weight field in RouteTargetReference object to specify relative preference. + +| `alternateBackends[]` +| `object` +| RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. + +| `host` +| `string` +| host is an alias/DNS that points to the service. Optional. If not specified a route name will typically be automatically chosen. Must follow DNS952 subdomain conventions. + +| `path` +| `string` +| path that the router watches for, to route traffic for to the service. Optional + +| `port` +| `object` +| RoutePort defines a port mapping from a router to an endpoint in the service endpoints. + +| `subdomain` +| `string` +| subdomain is a DNS subdomain that is requested within the ingress controller's domain (as a subdomain). If host is set this field is ignored. An ingress controller may choose to ignore this suggested name, in which case the controller will report the assigned name in the status.ingress array or refuse to admit the route. If this value is set and the server does not support this field host will be populated automatically. Otherwise host is left empty. The field may have multiple parts separated by a dot, but not all ingress controllers may honor the request. This field may not be changed after creation except by a user with the update routes/custom-host permission. + +Example: subdomain `frontend` automatically receives the router subdomain `apps.mycluster.com` to have a full hostname `frontend.apps.mycluster.com`. + +| `tls` +| `object` +| TLSConfig defines config used to secure a route and provide termination + +| `to` +| `object` +| RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. + +| `wildcardPolicy` +| `string` +| Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed. + +|=== +=== .spec.alternateBackends +Description:: ++ +-- +alternateBackends allows up to 3 additional backends to be assigned to the route. Only the Service kind is allowed, and it will be defaulted to Service. Use the weight field in RouteTargetReference object to specify relative preference. +-- + +Type:: + `array` + + + + +=== .spec.alternateBackends[] +Description:: ++ +-- +RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kind` +| `string` +| The kind of target that the route is referring to. Currently, only 'Service' is allowed + +| `name` +| `string` +| name of the service/target that is being referred to. e.g. name of the service + +| `weight` +| `integer` +| weight as an integer between 0 and 256, default 100, that specifies the target's relative weight against other target reference objects. 0 suppresses requests to this backend. + +|=== +=== .spec.port +Description:: ++ +-- +RoutePort defines a port mapping from a router to an endpoint in the service endpoints. +-- + +Type:: + `object` + +Required:: + - `targetPort` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `targetPort` +| `IntOrString` +| The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required + +|=== +=== .spec.tls +Description:: ++ +-- +TLSConfig defines config used to secure a route and provide termination +-- + +Type:: + `object` + +Required:: + - `termination` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `caCertificate` +| `string` +| caCertificate provides the cert authority certificate contents + +| `certificate` +| `string` +| certificate provides certificate contents. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate. + +| `destinationCACertificate` +| `string` +| destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt termination this file should be provided in order to have routers use it for health checks on the secure connection. If this field is not specified, the router may provide its own destination CA and perform hostname validation using the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically verify. + +| `insecureEdgeTerminationPolicy` +| `string` +| insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While each router may make its own decisions on which ports to expose, this is normally port 80. + +* Allow - traffic is sent to the server on the insecure port (default) * Disable - no traffic is allowed on the insecure port. * Redirect - clients are redirected to the secure port. + +| `key` +| `string` +| key provides key file contents + +| `termination` +| `string` +| termination indicates termination type. + +* edge - TLS termination is done by the router and http is used to communicate with the backend (default) * passthrough - Traffic is sent straight to the destination without the router providing TLS termination * reencrypt - TLS termination is done by the router and https is used to communicate with the backend + +|=== +=== .spec.to +Description:: ++ +-- +RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others. +-- + +Type:: + `object` + +Required:: + - `kind` + - `name` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `kind` +| `string` +| The kind of target that the route is referring to. Currently, only 'Service' is allowed + +| `name` +| `string` +| name of the service/target that is being referred to. e.g. name of the service + +| `weight` +| `integer` +| weight as an integer between 0 and 256, default 100, that specifies the target's relative weight against other target reference objects. 0 suppresses requests to this backend. + +|=== +=== .status +Description:: ++ +-- +RouteStatus provides relevant info about the status of a route, including which routers acknowledge it. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `ingress` +| `array` +| ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are `Ready` + +| `ingress[]` +| `object` +| RouteIngress holds information about the places where a route is exposed. + +|=== +=== .status.ingress +Description:: ++ +-- +ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are `Ready` +-- + +Type:: + `array` + + + + +=== .status.ingress[] +Description:: ++ +-- +RouteIngress holds information about the places where a route is exposed. +-- + +Type:: + `object` + + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `conditions` +| `array` +| Conditions is the state of the route, may be empty. + +| `conditions[]` +| `object` +| RouteIngressCondition contains details for the current condition of this route on a particular router. + +| `host` +| `string` +| Host is the host string under which the route is exposed; this value is required + +| `routerCanonicalHostname` +| `string` +| CanonicalHostname is the external host name for the router that can be used as a CNAME for the host requested for this route. This value is optional and may not be set in all cases. + +| `routerName` +| `string` +| Name is a name chosen by the router to identify itself; this value is required + +| `wildcardPolicy` +| `string` +| Wildcard policy is the wildcard policy that was allowed where this route is exposed. + +|=== +=== .status.ingress[].conditions +Description:: ++ +-- +Conditions is the state of the route, may be empty. +-- + +Type:: + `array` + + + + +=== .status.ingress[].conditions[] +Description:: ++ +-- +RouteIngressCondition contains details for the current condition of this route on a particular router. +-- + +Type:: + `object` + +Required:: + - `type` + - `status` + + + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `lastTransitionTime` +| `Time` +| RFC 3339 date and time when this condition last transitioned + +| `message` +| `string` +| Human readable message indicating details about last transition. + +| `reason` +| `string` +| (brief) reason for the condition's last transition, and is usually a machine and human readable constant + +| `status` +| `string` +| Status is the status of the condition. Can be True, False, Unknown. + +| `type` +| `string` +| Type is the type of the condition. Currently only Admitted. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/route.openshift.io/v1/routes` +- `GET`: list or watch objects of kind Route +* `/apis/route.openshift.io/v1/watch/routes` +- `GET`: watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. +* `/apis/route.openshift.io/v1/namespaces/{namespace}/routes` +- `DELETE`: delete collection of Route +- `GET`: list or watch objects of kind Route +- `POST`: create a Route +* `/apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes` +- `GET`: watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. +* `/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}` +- `DELETE`: delete a Route +- `GET`: read the specified Route +- `PATCH`: partially update the specified Route +- `PUT`: replace the specified Route +* `/apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name}` +- `GET`: watch changes to an object of kind Route. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. +* `/apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status` +- `GET`: read status of the specified Route +- `PATCH`: partially update status of the specified Route +- `PUT`: replace status of the specified Route + + +=== /apis/route.openshift.io/v1/routes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Route + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `RouteList` schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/routes + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `WatchEvent` schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/namespaces/{namespace}/routes + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `dryRun` +| `string` +| 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 +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `DeleteOptions` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `Status` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list or watch objects of kind Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `RouteList` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create a Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 202 - Accepted +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of Route. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `WatchEvent` schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Route +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete a Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `DeleteOptions` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `Status` schema +| 202 - Accepted +| `Status` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified Route + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `Patch` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/watch/namespaces/{namespace}/routes/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Route +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind Route. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `WatchEvent` schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/route.openshift.io/v1/namespaces/{namespace}/routes/{name}/status + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the Route +| `namespace` +| `string` +| object name and auth scope, such as for teams and projects +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `GET` + +Description:: + read status of the specified Route + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update status of the specified Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). +| `force` +| `boolean` +| Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `Patch` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace status of the specified Route + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 201 - Created +| xref:../network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[`Route`] schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc b/microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc new file mode 100644 index 000000000000..223d8d3a9356 --- /dev/null +++ b/microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc @@ -0,0 +1,661 @@ +// Automatically generated by 'openshift-apidocs-gen'. Do not edit. +:_content-type: ASSEMBLY +[id="securitycontextconstraints-security-openshift-io-v1"] += SecurityContextConstraints [security.openshift.io/v1] +:toc: macro +:toc-title: + +toc::[] + + +Description:: ++ +-- +SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container. For historical reasons SCC was exposed under the core Kubernetes API group. That exposure is deprecated and will be removed in a future release - users should instead use the security.openshift.io group to manage SecurityContextConstraints. + Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). +-- + +Type:: + `object` + +Required:: + - `allowHostDirVolumePlugin` + - `allowHostIPC` + - `allowHostNetwork` + - `allowHostPID` + - `allowHostPorts` + - `allowPrivilegedContainer` + - `readOnlyRootFilesystem` + + +== Specification + +[cols="1,1,1",options="header"] +|=== +| Property | Type | Description + +| `allowHostDirVolumePlugin` +| `boolean` +| AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin + +| `allowHostIPC` +| `boolean` +| AllowHostIPC determines if the policy allows host ipc in the containers. + +| `allowHostNetwork` +| `boolean` +| AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + +| `allowHostPID` +| `boolean` +| AllowHostPID determines if the policy allows host pid in the containers. + +| `allowHostPorts` +| `boolean` +| AllowHostPorts determines if the policy allows host ports in the containers. + +| `allowPrivilegeEscalation` +| `` +| AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. + +| `allowPrivilegedContainer` +| `boolean` +| AllowPrivilegedContainer determines if a container can request to be run as privileged. + +| `allowedCapabilities` +| `` +| AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. To allow all capabilities you may use '*'. + +| `allowedFlexVolumes` +| `` +| AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "Volumes" field. + +| `allowedUnsafeSysctls` +| `` +| AllowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection. + Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. + +| `apiVersion` +| `string` +| 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 + +| `defaultAddCapabilities` +| `` +| DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities. + +| `defaultAllowPrivilegeEscalation` +| `` +| DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. + +| `forbiddenSysctls` +| `` +| ForbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. + Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. + +| `fsGroup` +| `` +| FSGroup is the strategy that will dictate what fs group is used by the SecurityContext. + +| `groups` +| `` +| The groups that have permission to use this security context constraints + +| `kind` +| `string` +| 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 + +| `metadata` +| `ObjectMeta` +| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +| `priority` +| `` +| Priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. An unset value is considered a 0 priority. If scores for multiple SCCs are equal they will be sorted from most restrictive to least restrictive. If both priorities and restrictions are equal the SCCs will be sorted by name. + +| `readOnlyRootFilesystem` +| `boolean` +| ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. + +| `requiredDropCapabilities` +| `` +| RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. + +| `runAsUser` +| `` +| RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. + +| `seLinuxContext` +| `` +| SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. + +| `seccompProfiles` +| `` +| SeccompProfiles lists the allowed profiles that may be set for the pod or container's seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default. + +| `supplementalGroups` +| `` +| SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + +| `users` +| `` +| The users who have permissions to use this security context constraints + +| `volumes` +| `` +| Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use "*". To allow no volumes, set to ["none"]. + +|=== + +== API endpoints + +The following API endpoints are available: + +* `/apis/security.openshift.io/v1/securitycontextconstraints` +- `DELETE`: delete collection of SecurityContextConstraints +- `GET`: list objects of kind SecurityContextConstraints +- `POST`: create SecurityContextConstraints +* `/apis/security.openshift.io/v1/watch/securitycontextconstraints` +- `GET`: watch individual changes to a list of SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead. +* `/apis/security.openshift.io/v1/securitycontextconstraints/{name}` +- `DELETE`: delete SecurityContextConstraints +- `GET`: read the specified SecurityContextConstraints +- `PATCH`: partially update the specified SecurityContextConstraints +- `PUT`: replace the specified SecurityContextConstraints +* `/apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}` +- `GET`: watch changes to an object of kind SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +=== /apis/security.openshift.io/v1/securitycontextconstraints + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete collection of SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `Status` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + list objects of kind SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `SecurityContextConstraintsList` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `POST` + +Description:: + create SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `fieldValidation` +| `string` +| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. 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 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - 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 when the `ServerSideFieldValidation` feature gate is enabled. - 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. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 201 - Created +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 202 - Accepted +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/securitycontextconstraints + + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch individual changes to a list of SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `WatchEvent` schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/securitycontextconstraints/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the SecurityContextConstraints +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +|=== + +HTTP method:: + `DELETE` + +Description:: + delete SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `gracePeriodSeconds` +| `integer` +| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +| `orphanDependents` +| `boolean` +| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. +| `propagationPolicy` +| `string` +| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `DeleteOptions` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `Status` schema +| 202 - Accepted +| `Status` schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `GET` + +Description:: + read the specified SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +|=== + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PATCH` + +Description:: + partially update the specified SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `fieldValidation` +| `string` +| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. 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 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - 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 when the `ServerSideFieldValidation` feature gate is enabled. - 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. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| `Patch` schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + +HTTP method:: + `PUT` + +Description:: + replace the specified SecurityContextConstraints + + +.Query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `dryRun` +| `string` +| 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 +| `fieldManager` +| `string` +| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +| `fieldValidation` +| `string` +| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. 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 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - 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 when the `ServerSideFieldValidation` feature gate is enabled. - 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. +|=== + +.Body parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `body` +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| +|=== + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 201 - Created +| xref:../security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[`SecurityContextConstraints`] schema +| 401 - Unauthorized +| Empty +|=== + + +=== /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name} + +.Global path parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `name` +| `string` +| name of the SecurityContextConstraints +|=== + +.Global query parameters +[cols="1,1,2",options="header"] +|=== +| Parameter | Type | Description +| `allowWatchBookmarks` +| `boolean` +| allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. +| `continue` +| `string` +| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". + +This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +| `fieldSelector` +| `string` +| A selector to restrict the list of returned objects by their fields. Defaults to everything. +| `labelSelector` +| `string` +| A selector to restrict the list of returned objects by their labels. Defaults to everything. +| `limit` +| `integer` +| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. + +The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +| `pretty` +| `string` +| If 'true', then the output is pretty printed. +| `resourceVersion` +| `string` +| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `resourceVersionMatch` +| `string` +| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. + +Defaults to unset +| `timeoutSeconds` +| `integer` +| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +| `watch` +| `boolean` +| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +|=== + +HTTP method:: + `GET` + +Description:: + watch changes to an object of kind SecurityContextConstraints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. + + +.HTTP responses +[cols="1,1",options="header"] +|=== +| HTTP code | Reponse body +| 200 - OK +| `WatchEvent` schema +| 401 - Unauthorized +| Empty +|=== + + diff --git a/modules/microshift-k8s-apis.adoc b/modules/microshift-k8s-apis.adoc index 17d4d8e8cb57..925eb6d2cfd2 100644 --- a/modules/microshift-k8s-apis.adoc +++ b/modules/microshift-k8s-apis.adoc @@ -13,10 +13,10 @@ NOTE: TABLE IS FOR PLACEMENT ONLY (FPO) [cols="1,1",options="header"] |=== ^| API ^| API group -| xref:../rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route] +| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route] | route.openshift.io/v1 -| xref:../rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] +| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] | security.openshift.io/v1 |=== -//FIXME: Links are broken, table is incorrectly displaying \ No newline at end of file +//FIXME: Links are broken, table is incorrectly displaying diff --git a/modules/microshift-openshift-apis.adoc b/modules/microshift-openshift-apis.adoc index e14c355e55cb..9c35e062bd44 100644 --- a/modules/microshift-openshift-apis.adoc +++ b/modules/microshift-openshift-apis.adoc @@ -11,8 +11,8 @@ In addition to the standard Kubernetes APIs, {product-title} includes a subset o [cols="1,1",options="header"] |=== ^| API ^| API group -| xref:../rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route] +| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route] | route.openshift.io/v1 -| xref:../rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] +| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] | security.openshift.io/v1 |===