#Rollout [argoproj.io/v1alpha1]

类型

object

必填

spec

#规格

#.spec

类型

object

类型

object

类型

object

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

object

类型

object

必填

activeService

类型

object

类型

object

类型

object

类型

object

类型

object

必填

weight

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

必填

fieldPath

类型

array

类型

object

必填

metricName

类型

array

类型

object

必填

limitmetricName

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

必填

fieldPath

类型

array

类型

object

必填

metricName

类型

array

类型

object

必填

limitmetricName

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

必填

fieldPath

类型

array

类型

object

必填

metricName

类型

array

类型

object

必填

limitmetricName

类型

array

类型

object

类型

object

类型

object

必填

weight

类型

object

类型

object

类型

object

类型

object

类型

object

必填

pingServicepongService

类型

object

类型

object

类型

object

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

必填

fieldPath

类型

array

类型

object

必填

metricName

类型

array

类型

object

必填

limitmetricName

类型

array

类型

object

类型

object

必填

templates

类型

array

类型

object

必填

nametemplateName

类型

array

类型

object

必填

name

类型

object

类型

object

必填

fieldPath

类型

object

类型

object

类型

object

类型

array

类型

object

必填

metricName

类型

array

类型

object

必填

namespecRef

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

object

类型

object

类型

object

必填

name

类型

object

类型

object

类型

object

类型

array

类型

object

必填

headerNameheaderValue

类型

object

类型

object

必填

name

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

必填

servicePort

类型

array

类型

string

类型

object

必填

durationSecondsenabled

类型

object

必填

mappings

类型

array

类型

string

类型

object

类型

object

必填

name

类型

array

类型

string

类型

object

类型

object

必填

canaryVirtualNodeRefstableVirtualNodeRef

类型

object

必填

name

类型

object

必填

name

类型

object

必填

name

类型

array

类型

string

类型

object

类型

object

必填

canarySubsetNamenamestableSubsetName

类型

object

必填

name

类型

array

类型

string

类型

array

类型

object

类型

array

类型

object

类型

array

类型

string

类型

array

类型

object

必填

name

类型

array

类型

string

类型

array

类型

object

类型

array

类型

object

类型

array

类型

string

类型

array

类型

object

必填

name

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

类型

object

类型

object

必填

weightedTraefikServiceName

类型

object

类型

object

必填

containers

类型

object

类型

object

类型

array

类型

object

必填

preferenceweight

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

必填

nodeSelectorTerms

类型

array

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

object

必填

podAffinityTermweight

类型

object

必填

topologyKey

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

object

必填

topologyKey

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

object

类型

array

类型

object

必填

podAffinityTermweight

类型

object

必填

topologyKey

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

object

必填

topologyKey

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

object

必填

name

类型

array

类型

string

类型

array

类型

string

类型

array

类型

object

必填

name

类型

object

类型

object

必填

key

类型

object

必填

fieldPath

类型

object

必填

resource

类型

object

必填

key

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

containerPort

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

resourceNamerestartPolicy

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

object

必填

type

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

devicePathname

类型

array

类型

object

必填

mountPathname

类型

object

类型

array

类型

string

类型

array

类型

object

类型

array

类型

string

类型

array

类型

object

必填

name

类型

array

类型

string

类型

array

类型

string

类型

array

类型

object

必填

name

类型

object

类型

object

必填

key

类型

object

必填

fieldPath

类型

object

必填

resource

类型

object

必填

key

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

containerPort

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

resourceNamerestartPolicy

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

object

必填

type

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

devicePathname

类型

array

类型

object

必填

mountPathname

类型

array

类型

object

类型

array

类型

string

类型

array

类型

object

类型

array

类型

object

必填

name

类型

array

类型

string

类型

array

类型

string

类型

array

类型

object

必填

name

类型

object

类型

object

必填

key

类型

object

必填

fieldPath

类型

object

必填

resource

类型

object

必填

key

类型

array

类型

object

类型

object

类型

object

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

seconds

类型

object

必填

port

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

containerPort

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

resourceNamerestartPolicy

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

类型

array

类型

string

类型

array

类型

string

类型

object

类型

object

必填

type

类型

object

类型

object

类型

object

类型

array

类型

string

类型

object

必填

port

类型

object

必填

port

类型

array

类型

object

必填

namevalue

类型

object

必填

port

类型

array

类型

object

必填

devicePathname

类型

array

类型

object

必填

mountPathname

类型

object

类型

object

必填

name

类型

object

类型

array

类型

object

必填

conditionType

类型

array

类型

object

必填

name

类型

object

类型

array

类型

object

必填

name

类型

object

类型

object

类型

object

必填

type

类型

array

类型

integer

类型

array

类型

object

必填

namevalue

类型

object

类型

array

类型

object

类型

array

类型

object

必填

maxSkewtopologyKeywhenUnsatisfiable

类型

object

类型

array

类型

object

必填

keyoperator

类型

array

类型

string

类型

object

类型

array

类型

string

类型

array

类型

类型

object

#.status

类型

object

类型

object

类型

object

必填

arnname

类型

object

必填

arnname

类型

object

必填

arnname

类型

array

类型

object

类型

object

必填

arnname

类型

object

必填

arnname

类型

object

必填

arnname

类型

object

类型

object

必填

namestatus

类型

object

必填

namestatus

类型

object

类型

object

必填

namestatus

类型

object

必填

namestatus

类型

array

类型

object

必填

indexnameoperation

类型

object

类型

object

必填

canarystable

类型

array

类型

object

必填

weight

类型

object

必填

weight

类型

object

必填

weight

类型

array

类型

object

必填

lastTransitionTimelastUpdateTimemessagereasonstatustype

类型

array

类型

object

必填

reasonstartTime

API 端点#

可用的 API 端点如下：

• /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts
  • DELETE: delete collection of Rollout
  • GET: list objects of kind Rollout
  • POST: create a new Rollout
• /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
  • DELETE: delete the specified Rollout
  • GET: read the specified Rollout
  • PATCH: partially update the specified Rollout
  • PUT: replace the specified Rollout
• /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
  • GET: read status of the specified Rollout
  • PATCH: partially update status of the specified Rollout
  • PUT: replace status of the specified Rollout
• /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/scale
  • GET: read scale of the specified Rollout
  • PATCH: partially update scale of the specified Rollout
  • PUT: replace scale of the specified Rollout

HTTP 方法

DELETE

描述

delete collection of Rollout

HTTP 响应

HTTP 方法

GET

描述

list objects of kind Rollout

HTTP 响应

HTTP 方法

POST

描述

create a new Rollout

查询参数

请求体参数

HTTP 响应

HTTP 方法

DELETE

描述

delete the specified Rollout

查询参数

HTTP 响应

HTTP 方法

GET

描述

read the specified Rollout

HTTP 响应

HTTP 方法

PATCH

描述

partially update the specified Rollout

查询参数

HTTP 响应

HTTP 方法

PUT

描述

replace the specified Rollout

查询参数

请求体参数

HTTP 响应

HTTP 方法

GET

描述

read status of the specified Rollout

HTTP 响应

HTTP 方法

PATCH

描述

partially update status of the specified Rollout

查询参数

HTTP 响应

HTTP 方法

PUT

描述

replace status of the specified Rollout

查询参数

请求体参数

HTTP 响应

HTTP 方法

GET

描述

read scale of the specified Rollout

HTTP 响应

HTTP 方法

PATCH

描述

partially update scale of the specified Rollout

查询参数

HTTP 方法

PUT

描述

replace scale of the specified Rollout

查询参数

请求体参数

#API usage

The Argo Rollouts kubectl plugin operates on the namespaced Rollout custom resource. The API server path for a Rollout is:

Use a bearer token in the Authorization header. Use application/merge-patch+json for the merge patches below and application/json-patch+json for the JSON Patch used by undo.

#Command-to-API mapping

Replace {cluster}, {namespace}, and {name} with the target cluster, namespace, and Rollout name.

#Get a rollout

get rollout builds its status tree from informers rather than issuing only one request. The initial cache population reads the following resources:

When the Rollout uses spec.workloadRef, the plugin also reads the referenced Deployment:

With --watch, the plugin watches these resources and refreshes the displayed tree when a related resource changes. The Rollout watch endpoint is:

The other related resources use their corresponding collection endpoint with watch=true and the current resourceVersion.

#List rollouts

List all Rollouts in a namespace:

Filter by name, as the plugin does for list rollouts --name:

List across all namespaces by omitting the namespace segment:

Watch the collection by adding watch=true. Start from the returned list's metadata.resourceVersion to avoid missing events:

#Pause a rollout

pause sends a merge patch to the Rollout resource:

#Resume a rollout

The current v1.2.0 source registers promote, not a separate resume command. A legacy resume implementation used this merge patch on the main Rollout resource:

For clusters with the Rollout status subresource enabled, send the two fields as separate requests instead:

Use promote when the Rollout is paused by a canary step, a blue-green pre-promotion, or an analysis step. promote also advances the canary step when necessary.

#Promote a rollout

promote first reads the Rollout:

The follow-up patch depends on the returned spec and status:

For example, clear an automatic pause condition:

Advance a canary rollout to the next step:

Fully promote a rollout:

A client must not blindly send every field above. Read the Rollout first and apply only the patch required by its current state. The plugin first attempts a status-subresource patch. For clusters without that subresource, it falls back to a merge patch on the main Rollout resource.

#Abort a rollout

abort first tries the status subresource:

If the status subresource returns 404 Not Found, send the same patch to the main Rollout resource:

The Rollout controller handles the abort and reconciles the active ReplicaSet. The patch does not change spec.template; update the template separately if the new version must be fully reverted.

#Set a rollout image

set image first reads the Rollout:

The plugin changes the matching container image in spec.template.spec.initContainers, containers, or ephemeralContainers. It then sends a full-object update, not a small patch.

For a Rollout without spec.workloadRef:

The request body must be the complete Rollout returned by the GET request, with the selected image changed. Preserve metadata.resourceVersion and all fields not being changed. A shortened example is:

When spec.workloadRef is present, the v1.2.0 plugin treats workloadRef.name as an apps/v1 Deployment name, then reads and updates that Deployment instead:

set image does not branch on workloadRef.kind in the v1.2.0 source; it always uses the Deployment endpoint shown above. On an optimistic-concurrency conflict, repeat the GET and full update. The plugin retries this sequence up to five times.

#Undo a rollout

undo restores the previous revision by copying its pod template. The plugin performs these reads first:

It considers only ReplicaSets controlled by the Rollout and selects the previous ReplicaSet by the rollout.argoproj.io/revision annotation. Use --to-revision={revision} to select an explicit revision; without it, the plugin selects the second newest revision. If the selected pod template already matches the current template, no update is sent.

The plugin removes the rollouts-pod-template-hash label from the selected pod template and sends this JSON Patch:

When spec.workloadRef is present, apply the same JSON Patch to the referenced object instead of the Rollout:

For a ReplicaSet workload reference use /apis/apps/v1/.../replicasets/{workloadName}. For a PodTemplate workload reference use /api/v1/.../podtemplates/{workloadName}. The v1.2.0 implementation rejects unsupported workloadRef.kind values.

#Permissions

The caller needs permission to read Rollouts and their related resources. Mutating operations additionally require the corresponding patch or update permission:

• get rollout: list and watch on Rollouts, ReplicaSets, Pods, Experiments, AnalysisRuns, and referenced Deployments. A direct GET request, outside the plugin's informer flow, requires get.
• list rollouts: list on Rollouts; add watch when watching the collection.
• pause, resume, promote, and abort: patch on Rollouts and, when used, patch on the Rollout status subresource.
• set image: get and update on Rollouts, or get and update on the referenced Deployment.
• undo: get and list on Rollouts and ReplicaSets, plus patch on the Rollout or referenced workload.