Config is the configuration object for a registry instance managed by the registry operator
object
metadata
spec
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
ImageRegistrySpec defines the specs for the running registry. |
|
|
ImageRegistryStatus reports image registry operational status. |
ImageRegistrySpec defines the specs for the running registry.
object
logging
managementState
replicas
Property | Type | Description |
---|---|---|
|
|
defaultRoute indicates whether an external facing route for the registry should be created using the default generated hostname. |
|
|
disableRedirect controls whether to route all data through the Registry, rather than redirecting to the backend. |
|
|
httpSecret is the value needed by the registry to secure uploads, generated by default. |
|
|
logging determines the level of logging enabled in the registry. |
|
|
managementState indicates whether the registry instance represented by this config instance is under operator management or not. Valid values are Managed, Unmanaged, and Removed. |
|
|
nodeSelector defines the node selection constraints for the registry pod. |
|
|
proxy defines the proxy to be used when calling master api, upstream registries, etc. |
|
|
readOnly indicates whether the registry instance should reject attempts to push new images or delete existing ones. |
|
|
replicas determines the number of registry instances to run. |
|
|
requests controls how many parallel requests a given registry instance will handle before queuing additional requests. |
|
|
resources defines the resource requests+limits for the registry pod. |
|
|
rolloutStrategy defines rollout strategy for the image registry deployment. |
|
|
routes defines additional external facing routes which should be created for the registry. |
|
|
ImageRegistryConfigRoute holds information on external route access to image registry. |
|
|
storage details for configuring registry storage, e.g. S3 bucket coordinates. |
|
|
tolerations defines the tolerations for the registry pod. |
|
|
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>. |
proxy defines the proxy to be used when calling master api, upstream registries, etc.
object
Property | Type | Description |
---|---|---|
|
|
http defines the proxy to be used by the image registry when accessing HTTP endpoints. |
|
|
https defines the proxy to be used by the image registry when accessing HTTPS endpoints. |
|
|
noProxy defines a comma-separated list of host names that shouldn’t go through any proxy. |
requests controls how many parallel requests a given registry instance will handle before queuing additional requests.
object
Property | Type | Description |
---|---|---|
|
|
read defines limits for image registry’s reads. |
|
|
write defines limits for image registry’s writes. |
read defines limits for image registry's reads.
object
Property | Type | Description |
---|---|---|
|
|
maxInQueue sets the maximum queued api requests to the registry. |
|
|
maxRunning sets the maximum in flight api requests to the registry. |
|
|
maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |
write defines limits for image registry's writes.
object
Property | Type | Description |
---|---|---|
|
|
maxInQueue sets the maximum queued api requests to the registry. |
|
|
maxRunning sets the maximum in flight api requests to the registry. |
|
|
maxWaitInQueue sets the maximum time a request can wait in the queue before being rejected. |
resources defines the resource requests+limits for the registry pod.
object
Property | Type | Description |
---|---|---|
|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
|
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
routes defines additional external facing routes which should be created for the registry.
array
ImageRegistryConfigRoute holds information on external route access to image registry.
object
name
Property | Type | Description |
---|---|---|
|
|
hostname for the route. |
|
|
name of the route to be created. |
|
|
secretName points to secret containing the certificates to be used by the route. |
storage details for configuring registry storage, e.g. S3 bucket coordinates.
object
Property | Type | Description |
---|---|---|
|
|
azure represents configuration that uses Azure Blob Storage. |
|
|
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. |
|
|
gcs represents configuration that uses Google Cloud Storage. |
|
|
pvc represents configuration that uses a PersistentVolumeClaim. |
|
|
s3 represents configuration that uses Amazon Simple Storage Service. |
|
|
swift represents configuration that uses OpenStack Object Storage. |
azure represents configuration that uses Azure Blob Storage.
object
Property | Type | Description |
---|---|---|
|
|
accountName defines the account to be used by the registry. |
|
|
container defines Azure’s container to be used by registry. |
emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever.
object
gcs represents configuration that uses Google Cloud Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. |
|
|
projectID is the Project ID of the GCP project that this bucket should be associated with. |
|
|
region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |
pvc represents configuration that uses a PersistentVolumeClaim.
object
Property | Type | Description |
---|---|---|
|
|
claim defines the Persisent Volume Claim’s name to be used. |
s3 represents configuration that uses Amazon Simple Storage Service.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
cloudFront configures Amazon Cloudfront as the storage middleware in a registry. |
|
|
encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. |
|
|
keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. |
|
|
region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. |
|
|
regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided. |
cloudFront configures Amazon Cloudfront as the storage middleware in a registry.
object
baseURL
keypairID
privateKey
Property | Type | Description |
---|---|---|
|
|
baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. |
|
|
duration is the duration of the Cloudfront session. |
|
|
keypairID is key pair ID provided by AWS. |
|
|
privateKey points to secret containing the private key, provided by AWS. |
privateKey points to secret containing the private key, provided by AWS.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
swift represents configuration that uses OpenStack Object Storage.
object
Property | Type | Description |
---|---|---|
|
|
authURL defines the URL for obtaining an authentication token. |
|
|
authVersion specifies the OpenStack Auth’s version. |
|
|
container defines the name of Swift container where to store the registry’s data. |
|
|
domain specifies Openstack’s domain name for Identity v3 API. |
|
|
domainID specifies Openstack’s domain id for Identity v3 API. |
|
|
regionName defines Openstack’s region in which container exists. |
|
|
tenant defines Openstack tenant name to be used by registry. |
|
|
tenant defines Openstack tenant id to be used by registry. |
tolerations defines the tolerations for the registry pod.
array
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
object
Property | Type | Description |
---|---|---|
|
|
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
|
|
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
|
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
ImageRegistryStatus reports image registry operational status.
object
storage
storageManaged
Property | Type | Description |
---|---|---|
|
|
conditions is a list of conditions and their status |
|
|
OperatorCondition is just the standard condition fields. |
|
|
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction. |
|
|
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made. |
|
|
observedGeneration is the last generation change you’ve dealt with |
|
|
readyReplicas indicates how many replicas are ready and at the desired state |
|
|
storage indicates the current applied storage configuration of the registry. |
|
|
storageManaged is a boolean which denotes whether or not we created the registry storage medium (such as an S3 bucket). |
|
|
version is the level this availability applies to |
conditions is a list of conditions and their status
array
OperatorCondition is just the standard condition fields.
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
array
GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.
object
Property | Type | Description |
---|---|---|
|
|
group is the group of the thing you’re tracking |
|
|
hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps |
|
|
lastGeneration is the last generation of the workload controller involved |
|
|
name is the name of the thing you’re tracking |
|
|
namespace is where the thing you’re tracking is |
|
|
resource is the resource type of the thing you’re tracking |
storage indicates the current applied storage configuration of the registry.
object
Property | Type | Description |
---|---|---|
|
|
azure represents configuration that uses Azure Blob Storage. |
|
|
emptyDir represents ephemeral storage on the pod’s host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever. |
|
|
gcs represents configuration that uses Google Cloud Storage. |
|
|
pvc represents configuration that uses a PersistentVolumeClaim. |
|
|
s3 represents configuration that uses Amazon Simple Storage Service. |
|
|
swift represents configuration that uses OpenStack Object Storage. |
azure represents configuration that uses Azure Blob Storage.
object
Property | Type | Description |
---|---|---|
|
|
accountName defines the account to be used by the registry. |
|
|
container defines Azure’s container to be used by registry. |
emptyDir represents ephemeral storage on the pod's host node. WARNING: this storage cannot be used with more than 1 replica and is not suitable for production use. When the pod is removed from a node for any reason, the data in the emptyDir is deleted forever.
object
gcs represents configuration that uses Google Cloud Storage.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
keyID is the KMS key ID to use for encryption. Optional, buckets are encrypted by default on GCP. This allows for the use of a custom encryption key. |
|
|
projectID is the Project ID of the GCP project that this bucket should be associated with. |
|
|
region is the GCS location in which your bucket exists. Optional, will be set based on the installed GCS Region. |
pvc represents configuration that uses a PersistentVolumeClaim.
object
Property | Type | Description |
---|---|---|
|
|
claim defines the Persisent Volume Claim’s name to be used. |
s3 represents configuration that uses Amazon Simple Storage Service.
object
Property | Type | Description |
---|---|---|
|
|
bucket is the bucket name in which you want to store the registry’s data. Optional, will be generated if not provided. |
|
|
cloudFront configures Amazon Cloudfront as the storage middleware in a registry. |
|
|
encrypt specifies whether the registry stores the image in encrypted format or not. Optional, defaults to false. |
|
|
keyID is the KMS key ID to use for encryption. Optional, Encrypt must be true, or this parameter is ignored. |
|
|
region is the AWS region in which your bucket exists. Optional, will be set based on the installed AWS Region. |
|
|
regionEndpoint is the endpoint for S3 compatible storage services. Optional, defaults based on the Region that is provided. |
cloudFront configures Amazon Cloudfront as the storage middleware in a registry.
object
baseURL
keypairID
privateKey
Property | Type | Description |
---|---|---|
|
|
baseURL contains the SCHEME://HOST[/PATH] at which Cloudfront is served. |
|
|
duration is the duration of the Cloudfront session. |
|
|
keypairID is key pair ID provided by AWS. |
|
|
privateKey points to secret containing the private key, provided by AWS. |
privateKey points to secret containing the private key, provided by AWS.
object
key
Property | Type | Description |
---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? |
|
|
Specify whether the Secret or its key must be defined |
swift represents configuration that uses OpenStack Object Storage.
object
Property | Type | Description |
---|---|---|
|
|
authURL defines the URL for obtaining an authentication token. |
|
|
authVersion specifies the OpenStack Auth’s version. |
|
|
container defines the name of Swift container where to store the registry’s data. |
|
|
domain specifies Openstack’s domain name for Identity v3 API. |
|
|
domainID specifies Openstack’s domain id for Identity v3 API. |
|
|
regionName defines Openstack’s region in which container exists. |
|
|
tenant defines Openstack tenant name to be used by registry. |
|
|
tenant defines Openstack tenant id to be used by registry. |
The following API endpoints are available:
/apis/imageregistry.operator.openshift.io/v1/configs
DELETE
: delete collection of Config
GET
: list objects of kind Config
POST
: create a Config
/apis/imageregistry.operator.openshift.io/v1/configs/{name}
DELETE
: delete a Config
GET
: read the specified Config
PATCH
: partially update the specified Config
PUT
: replace the specified Config
/apis/imageregistry.operator.openshift.io/v1/configs/{name}/status
GET
: read status of the specified Config
PATCH
: partially update status of the specified Config
PUT
: replace status of the specified Config
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete collection of Config
Parameter | Type | Description |
---|---|---|
|
|
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
|
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. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
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. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind Config
Parameter | Type | Description |
---|---|---|
|
|
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
|
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. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
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. |
|
|
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the Config |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete a Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
|
|
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. |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the Config |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
GET
read status of the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When specified: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update status of the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace status of the specified Config
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |