Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add rollout API spec #897

Merged
merged 4 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
477 changes: 477 additions & 0 deletions apis/placement/v1alpha1/stagedupdate_types.go

Large diffs are not rendered by default.

444 changes: 444 additions & 0 deletions apis/placement/v1alpha1/zz_generated.deepcopy.go

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions apis/placement/v1beta1/clusterresourceplacement_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -410,10 +410,11 @@ const (

// RolloutStrategy describes how to roll out a new change in selected resources to target clusters.
type RolloutStrategy struct {
// Type of rollout. The only supported type is "RollingUpdate". Default is "RollingUpdate".
// Type of rollout. The only supported types are "RollingUpdate" and "External".
// Default is "RollingUpdate".
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Enum=RollingUpdate
// +kubebuilder:default=RollingUpdate
// +kubebuilder:validation:Enum=RollingUpdate;External
Type RolloutStrategyType `json:"type,omitempty"`

// Rolling update config params. Present only if RolloutStrategyType = RollingUpdate.
Expand Down Expand Up @@ -515,6 +516,10 @@ const (
// RollingUpdateRolloutStrategyType replaces the old placed resource using rolling update
// i.e. gradually create the new one while replace the old ones.
RollingUpdateRolloutStrategyType RolloutStrategyType = "RollingUpdate"

// ExternalRolloutStrategyType means there is an external rollout controller that will
// handle the rollout of the resources.
ExternalRolloutStrategyType RolloutStrategyType = "External"
)

// RollingUpdateConfig contains the config to control the desired behavior of rolling update.
Expand Down
5 changes: 3 additions & 2 deletions apis/placement/v1beta1/commons.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,10 @@ const (
// NamespacedName comprises a resource name, with a mandatory namespace.
type NamespacedName struct {
// Name is the name of the namespaced scope resource.
// +required
// +kubebuilder:validation:Required
Name string `json:"name"`

// Namespace is namespace of the namespaced scope resource.
// +required
// +kubebuilder:validation:Required
Namespace string `json:"namespace"`
}
150 changes: 150 additions & 0 deletions config/crd/bases/placement.kubernetes-fleet.io_approvalrequests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.15.0
name: approvalrequests.placement.kubernetes-fleet.io
spec:
group: placement.kubernetes-fleet.io
names:
categories:
- fleet
- fleet-placement
kind: ApprovalRequest
listKind: ApprovalRequestList
plural: approvalrequests
singular: approvalrequest
scope: Namespaced
versions:
- name: v1alpha1
schema:
openAPIV3Schema:
description: |-
ApprovalRequest defines a request for the approval from the user.
The request object MUST have the following labels:
- `TargetUpdateRun` which points to the update run that this approval request is for.
- `TargetStage` which is the name of the stage that this approval request is for.
- `IsLatestUpdateRunApproval` which indicates whether this approval request is the latest one related to this update run.
properties:
apiVersion:
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
type: string
kind:
description: |-
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
type: string
metadata:
type: object
spec:
description: The desired state of ApprovalRequest.
properties:
parentStageRollout:
description: The name of the staged update run that this approval
request is for.
type: string
targetStage:
description: The name of the update stage that this approval request
is for.
type: string
required:
- parentStageRollout
- targetStage
type: object
x-kubernetes-validations:
- message: The spec field is immutable
rule: self == oldSelf
status:
description: The desired state of ApprovalRequest.
properties:
conditions:
description: |-
Conditions is an array of current observed conditions for the specific type of post update task.
Known conditions are "Approved", and "ApprovalAccepted".
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
Original file line number Diff line number Diff line change
Expand Up @@ -1859,10 +1859,12 @@ spec:
type: object
type:
default: RollingUpdate
description: Type of rollout. The only supported type is "RollingUpdate".
description: |-
Type of rollout. The only supported types are "RollingUpdate" and "External".
Default is "RollingUpdate".
enum:
- RollingUpdate
- External
type: string
type: object
required:
Expand Down
Loading
Loading