diff --git a/api/v1beta1/remediation_types.go b/api/v1beta1/remediation_types.go index ddb337b85..52a6ef691 100644 --- a/api/v1beta1/remediation_types.go +++ b/api/v1beta1/remediation_types.go @@ -39,15 +39,15 @@ const ( // RemediationStrategy describes how to remediate machines. type RemediationStrategy struct { - // Type of remediation. + // Type represents the type of the remediation strategy. At the moment, only "Reboot" is supported. // +kubebuilder:default=Reboot // +optional Type RemediationType `json:"type,omitempty"` - // Sets maximum number of remediation retries. + // RetryLimit sets the maximum number of remediation retries. Zero retries if not set. // +optional RetryLimit int `json:"retryLimit,omitempty"` - // Sets the timeout between remediation retries. + // Timeout sets the timeout between remediation retries. It should be of the form "10m", or "40s". Timeout *metav1.Duration `json:"timeout"` } diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml index 3db054334..7c441bfac 100644 --- a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml +++ b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediations.yaml @@ -72,14 +72,17 @@ spec: description: Strategy field defines remediation strategy. properties: retryLimit: - description: Sets maximum number of remediation retries. + description: RetryLimit sets the maximum number of remediation + retries. Zero retries if not set. type: integer timeout: - description: Sets the timeout between remediation retries. + description: Timeout sets the timeout between remediation retries. + It should be of the form "10m", or "40s". type: string type: default: Reboot - description: Type of remediation. + description: Type represents the type of the remediation strategy. + At the moment, only "Reboot" is supported. type: string required: - timeout diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml index 23f9b3384..1e3625de4 100644 --- a/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml +++ b/config/crd/bases/infrastructure.cluster.x-k8s.io_hcloudremediationtemplates.yaml @@ -70,14 +70,17 @@ spec: description: Strategy field defines remediation strategy. properties: retryLimit: - description: Sets maximum number of remediation retries. + description: RetryLimit sets the maximum number of remediation + retries. Zero retries if not set. type: integer timeout: - description: Sets the timeout between remediation retries. + description: Timeout sets the timeout between remediation + retries. It should be of the form "10m", or "40s". type: string type: default: Reboot - description: Type of remediation. + description: Type represents the type of the remediation + strategy. At the moment, only "Reboot" is supported. type: string required: - timeout diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml index f6567f111..38c596632 100644 --- a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml +++ b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediations.yaml @@ -73,14 +73,17 @@ spec: applied. properties: retryLimit: - description: Sets maximum number of remediation retries. + description: RetryLimit sets the maximum number of remediation + retries. Zero retries if not set. type: integer timeout: - description: Sets the timeout between remediation retries. + description: Timeout sets the timeout between remediation retries. + It should be of the form "10m", or "40s". type: string type: default: Reboot - description: Type of remediation. + description: Type represents the type of the remediation strategy. + At the moment, only "Reboot" is supported. type: string required: - timeout diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml index 297569f9f..4d8731692 100644 --- a/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml +++ b/config/crd/bases/infrastructure.cluster.x-k8s.io_hetznerbaremetalremediationtemplates.yaml @@ -71,14 +71,17 @@ spec: to be applied. properties: retryLimit: - description: Sets maximum number of remediation retries. + description: RetryLimit sets the maximum number of remediation + retries. Zero retries if not set. type: integer timeout: - description: Sets the timeout between remediation retries. + description: Timeout sets the timeout between remediation + retries. It should be of the form "10m", or "40s". type: string type: default: Reboot - description: Type of remediation. + description: Type represents the type of the remediation + strategy. At the moment, only "Reboot" is supported. type: string required: - timeout