# ControllerRevision

ControllerRevisionControllerRevision implements an immutable snapshot of state data.apiVersion: apps/v1import "k8s.io/api/apps/v1"ControllerRevisionControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.apiVersion: apps/v1kind: ControllerRevisionmetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadatarevision (int64), requiredRevision indicates the revision of the state represented by Data.data (RawExtension)Data is the serialized representation of the state.*RawExtension is used to hold extensions in external versions.To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.// Internal package:type MyAPIObject struct { runtime.TypeMeta json:",inline" MyPlugin runtime.Object json:"myPlugin" }type PluginA struct { AOption string json:"aOption" }// External package:type MyAPIObject struct { runtime.TypeMeta json:",inline" MyPlugin runtime.RawExtension json:"myPlugin" }type PluginA struct { AOption string json:"aOption" }// On the wire, the JSON will look something like this:{ "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, }So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)*ControllerRevisionListControllerRevisionList is a resource containing a list of ControllerRevision objects.apiVersion: apps/v1kind: ControllerRevisionListmetadata (ListMeta)More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]ControllerRevision), requiredItems is the list of ControllerRevisionsOperationsget read the specified ControllerRevisionHTTP RequestGET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}Parametersname (in path): string, requiredname of the ControllerRevisionnamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (ControllerRevision): OK401: Unauthorizedlist list or watch objects of kind ControllerRevisionHTTP RequestGET /apis/apps/v1/namespaces/{namespace}/controllerrevisionsParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (ControllerRevisionList): OK401: Unauthorizedlist list or watch objects of kind ControllerRevisionHTTP RequestGET /apis/apps/v1/controllerrevisionsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (ControllerRevisionList): OK401: Unauthorizedcreate create a ControllerRevisionHTTP RequestPOST /apis/apps/v1/namespaces/{namespace}/controllerrevisionsParametersnamespace (in path): string, requirednamespacebody: ControllerRevision, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ControllerRevision): OK201 (ControllerRevision): Created202 (ControllerRevision): Accepted401: Unauthorizedupdate replace the specified ControllerRevisionHTTP RequestPUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}Parametersname (in path): string, requiredname of the ControllerRevisionnamespace (in path): string, requirednamespacebody: ControllerRevision, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (ControllerRevision): OK201 (ControllerRevision): Created401: Unauthorizedpatch partially update the specified ControllerRevisionHTTP RequestPATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}Parametersname (in path): string, requiredname of the ControllerRevisionnamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (ControllerRevision): OK201 (ControllerRevision): Created401: Unauthorizeddelete delete a ControllerRevisionHTTP RequestDELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}Parametersname (in path): string, requiredname of the ControllerRevisionnamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of ControllerRevisionHTTP RequestDELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisionsParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.