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.

Sign up for GitHub

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

Jump to bottom

Add Status Conditions for FAR CR #69

Merged
merged 3 commits into from
Aug 1, 2023
Merged

Add Status Conditions for FAR CR #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c91ae1
Add three status conditions for FAR CR
razo7 Aug 1, 2023
9b28a03
Restructure reconcile using the status conditions of FAR CR
razo7 Aug 1, 2023
1b38f7f
Add tests for status conditions
razo7 Aug 1, 2023
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
32 changes: 29 additions & 3 deletions api/v1alpha1/fenceagentsremediation_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,34 @@ import (
// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.

type ParameterName string
type NodeName string

const (
// FARFinalizer is a finalizer for a FenceAgentsRemediation CR deletion
FARFinalizer string = "fence-agents-remediation.medik8s.io/far-finalizer"
// Taints
FARNoExecuteTaintKey = "medik8s.io/fence-agents-remediation"
// FenceAgentActionSucceededType is the condition type used to signal whether the Fence Agent action was succeeded successfully or not
FenceAgentActionSucceededType = "FenceAgentActionSucceeded"
// condition messages
RemediationStartedConditionMessage = "FAR CR was found, the CR name matches one of the cluster nodes, and a finalizer was set"
FenceAgentSucceededConditionMessage = "FAR taint was added, fence agent command has been created and executed successfully"
RemediationFinishedConditionMessage = "The unhealthy node was fully remediated (it was tainted, fenced using FA and all the node resources have been deleted)"
)

// ProcessingChangeReason represents the reason of updating the processing condition
type ProcessingChangeReason string

const (
// RemediationStarted - CR was found, its name matches a node, and a finalizer was set
RemediationStarted ProcessingChangeReason = "RemediationStarted"
// FenceAgentSucceeded - FAR taint was added, fence agent command has been created and executed successfully
FenceAgentSucceeded ProcessingChangeReason = "FenceAgentSucceeded"
// RemediationFinished - The unhealthy node was fully remediated (it was tainted, fenced by FA and all of its resources have been deleted)
RemediationFinished ProcessingChangeReason = "RemediationFinished"
)

type ParameterName string
type NodeName string

// FenceAgentsRemediationSpec defines the desired state of FenceAgentsRemediation
type FenceAgentsRemediationSpec struct {
// Agent is the name of fence agent that will be used
Expand All @@ -52,6 +70,14 @@ type FenceAgentsRemediationSpec struct {
type FenceAgentsRemediationStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file

// Represents the observations of a FenceAgentsRemediation's current state.
// Known .status.conditions.type are: "Processing", "FenceAgentActionSucceeded", and "Succeeded".
// +listType=map
// +listMapKey=type
//+optional
// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="conditions",xDescriptors="urn:alm:descriptor:io.kubernetes.conditions"
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

//+kubebuilder:object:root=true
Expand Down
10 changes: 9 additions & 1 deletion api/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions bundle/manifests/fence-agents-remediation.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ spec:
which node is about to be fenced (i.e., they are common for all the nodes)
displayName: Shared Parameters
path: sharedparameters
statusDescriptors:
- description: 'Represents the observations of a FenceAgentsRemediation''s current
state. Known .status.conditions.type are: "Processing", "FenceAgentActionSucceeded",
and "Succeeded".'
displayName: conditions
path: conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
version: v1alpha1
- description: FenceAgentsRemediationTemplate is the Schema for the fenceagentsremediationtemplates
API
Expand Down
75 changes: 75 additions & 0 deletions bundle/manifests/fence-agents-remediation.medik8s.io_fenceagentsremediations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,81 @@ spec:
status:
description: FenceAgentsRemediationStatus defines the observed state of
FenceAgentsRemediation
properties:
conditions:
description: 'Represents the observations of a FenceAgentsRemediation''s
current state. Known .status.conditions.type are: "Processing",
"FenceAgentActionSucceeded", and "Succeeded".'
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n type FooStatus struct{ // Represents the observations of a
foo's current state. // Known .status.conditions.type are: \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
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
type: object
served: true
Expand Down
75 changes: 75 additions & 0 deletions config/crd/bases/fence-agents-remediation.medik8s.io_fenceagentsremediations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,81 @@ spec:
status:
description: FenceAgentsRemediationStatus defines the observed state of
FenceAgentsRemediation
properties:
conditions:
description: 'Represents the observations of a FenceAgentsRemediation''s
current state. Known .status.conditions.type are: "Processing",
"FenceAgentActionSucceeded", and "Succeeded".'
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n type FooStatus struct{ // Represents the observations of a
foo's current state. // Known .status.conditions.type are: \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
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
type: object
served: true
Expand Down
8 changes: 8 additions & 0 deletions config/manifests/bases/fence-agents-remediation.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ spec:
which node is about to be fenced (i.e., they are common for all the nodes)
displayName: Shared Parameters
path: sharedparameters
statusDescriptors:
- description: 'Represents the observations of a FenceAgentsRemediation''s current
state. Known .status.conditions.type are: "Processing", "FenceAgentActionSucceeded",
and "Succeeded".'
displayName: conditions
path: conditions
x-descriptors:
- urn:alm:descriptor:io.kubernetes.conditions
version: v1alpha1
- description: FenceAgentsRemediationTemplate is the Schema for the fenceagentsremediationtemplates
API
Expand Down
Loading