inernal/controller/kubecertagent: fix some godoc's

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
This commit is contained in:
Andrew Keesler 2020-09-24 13:53:06 -04:00
parent 409d10baf8
commit fab36c55f5
No known key found for this signature in database
GPG Key ID: 27CE0444346F9413
3 changed files with 8 additions and 3 deletions

View File

@ -25,8 +25,6 @@ type deleterController struct {
// NewDeleterController returns a controller that deletes any kube-cert-agent pods that are out of // NewDeleterController returns a controller that deletes any kube-cert-agent pods that are out of
// sync with the known kube-controller-manager pods. // sync with the known kube-controller-manager pods.
//
// This controller only uses the Template field of the provided agentInfo.
func NewDeleterController( func NewDeleterController(
agentPodConfig *AgentPodConfig, agentPodConfig *AgentPodConfig,
k8sClient kubernetes.Interface, k8sClient kubernetes.Interface,

View File

@ -30,6 +30,9 @@ type execerController struct {
// NewExecerController returns a controllerlib.Controller that listens for agent pods with proper // NewExecerController returns a controllerlib.Controller that listens for agent pods with proper
// cert/key path annotations and execs into them to get the cert/key material. It sets the retrieved // cert/key path annotations and execs into them to get the cert/key material. It sets the retrieved
// key material in a provided dynamicCertProvider. // key material in a provided dynamicCertProvider.
//
// It also is tasked with updating the CredentialIssuerConfig, located via the provided
// credentialIssuerConfigLocationConfig, with any errors that it encounters.
func NewExecerController( func NewExecerController(
credentialIssuerConfigLocationConfig *CredentialIssuerConfigLocationConfig, credentialIssuerConfigLocationConfig *CredentialIssuerConfigLocationConfig,
dynamicCertProvider dynamiccert.Provider, dynamicCertProvider dynamiccert.Provider,

View File

@ -33,8 +33,12 @@ const (
// ControllerManagerNamespace is the assumed namespace of the kube-controller-manager pod(s). // ControllerManagerNamespace is the assumed namespace of the kube-controller-manager pod(s).
ControllerManagerNamespace = "kube-system" ControllerManagerNamespace = "kube-system"
// controllerManagerNameAnnotationKey is used to store an agent pod's parent's name, i.e., the
// name of the controller manager pod with which it is supposed to be in sync.
controllerManagerNameAnnotationKey = "kube-cert-agent.pinniped.dev/controller-manager-name" controllerManagerNameAnnotationKey = "kube-cert-agent.pinniped.dev/controller-manager-name"
controllerManagerUIDAnnotationKey = "kube-cert-agent.pinniped.dev/controller-manager-uid" // controllerManagerUIDAnnotationKey is used to store an agent pod's parent's UID, i.e., the UID
// of the controller manager pod with which it is supposed to be in sync.
controllerManagerUIDAnnotationKey = "kube-cert-agent.pinniped.dev/controller-manager-uid"
// agentPodLabelKey is used to identify which pods are created by the kube-cert-agent // agentPodLabelKey is used to identify which pods are created by the kube-cert-agent
// controllers. // controllers.