kubernetes-sigs/cluster-api-provider-vsphere

Bootstrap failure detection

Open

#912 opened on May 8, 2020

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Go (320 forks)auto 404
help wantedkind/featurelifecycle/frozenpriority/important-soon

Repository metrics

Stars
 (417 stars)
PR merge metrics
 (PR metrics pending)

Description

/kind feature

Describe the solution you'd like If bootstrapping doesn't succeed, set VSphereMachine.Status.FailureReason and FailureMessage to indicate there was an error.

Anything else you would like to add: More information in https://github.com/kubernetes-sigs/cluster-api/issues/2554.

We may need to amend the bootstrap provider contract to require them to write a sentinel file indicating success to a specific location because not all bootstrap providers will necessarily use cloud-init and have that as a consistent means for checking success/failure. I will probably write up a separate proposal for that.

We will need a way for the CAPV controller to be able to determine the status for a given VSphereMachine. Does vCenter have any services where the bootstrap logic in the VM could send an update to indicate bootstrap success? Or maybe some way to label or tag the actual VM? This would need to be properly secured, presumably.

Contributor guide

Research direction
Investigate how to detect bootstrap failure by either reading a sentinel file from the VM or querying vCenter for VM status. Look at the bootstrap provider contract and see if there's a mechanism to report success/failure. Consider implementing a controller that watches for VSphereMachine status and updates FailureReason/FailureMessage accordingly.
Tech stack
go
Domain
backendinfrastructureapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoKubernetescluster apivSphere
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65