nodelock

Documentation

Overview

Package nodelock handles locking operations on the node.

Index

• type Lock
  • func New(tpm vtpm.TPMOpenFunc) *Lock
  • func (l *Lock) TryLockOnce(clusterID []byte) (bool, error)

Types

type Lock

type Lock struct {
	// contains filtered or unexported fields
}

Lock locks the node once there the join or the init is at a point where there is no turning back and the other operation does not need to continue.

This can be viewed as a state machine with two states: unlocked and locked. There is no way to unlock, so the state changes only once from unlock to locked.

func New

func New(tpm vtpm.TPMOpenFunc) *Lock

New creates a new NodeLock, which is unlocked.

func (*Lock) TryLockOnce

func (l *Lock) TryLockOnce(clusterID []byte) (bool, error)

TryLockOnce tries to lock the node. If the node is already locked, it returns false. If the node is unlocked, it locks it and returns true.